coolbeevip/gitlab-bot repository overview

⁠Gitlab Bot

This is a Gitlab bot that utilizes webhooks to automate certain tasks:

• Generate Release Notes for a designated milestone in Issues by utilizing the /bot-release-note command.
• Verify if the submitters email domain and username match during Merge requests.
• Confirm if a milestone has been specified in Merge requests.
• Validate if the commit titles adhere to the Conventional Commits Specification⁠ in Merge requests.

⁠GitLab Event Support

• Push Events (Not yet)
• Issue Events
• Comment Events
  • Commits
  • Merge Requests
  • Issues
  • Code Snippets
• Merge Request Events
• Wiki Page Events (Not yet)
• Tag Events (Not yet)
• Pipeline Events (Not yet)
• Build Events (Not yet)

⁠How to use

Starting a Gitlab Bot instance is simple:

docker run --rm \
-e BOT_GITLAB_USERNAME="Your Gitlab Username" \
-e BOT_GITLAB_URL="Your Gitlab URL" \
-e BOT_GITLAB_TOKEN="Your Gitlab Access Token" \
-p 9998:9998 \
coolbeevip/gitlab-bot

⁠Environment Variables

BOT_GITLAB_USERNAME / BOT_GITLAB_URL / BOT_GITLAB_TOKEN

These variables are used to configure the GitLab bot's authentication with the GitLab API. Please provide the following information:

• BOT_GITLAB_USERNAME: The username of the bot account on GitLab.
• BOT_GITLAB_URL: The URL of the GitLab instance the bot will be interacting with.
• BOT_GITLAB_TOKEN: The token used to authenticate the bot with the GitLab API.

BOT_LANGUAGE

Supports both Chinese (zh) and English (en) languages by default.

BOT_HOST / BOT_PORT

These variables specify the host and port on which the bot will run. By default, the bot will run on the IP address 0.0.0.0 and port number 9998.

BOT_GIT_EMAIL_DOMAIN

This configuration specifies the email domain that will be used for email addresses when making Git commits. For example:

BOT_GIT_EMAIL_DOMAIN=gmail.com

BOT_GIT_COMMIT_SUBJECT_MAX_LENGTH

The maximum character length allowed for Git commit subjects is 100, which is the default value.

BOT_GIT_COMMIT_SUBJECT_REGEX / BOT_GIT_COMMIT_SUBJECT_EXAMPLES_MARKDOWN / BOT_GIT_COMMIT_SUBJECT_REGEX_ENABLED

Regular expression pattern Conventional Commits Specification⁠ and example commit subjects are used to validate and provide guidance for Git commit messages. Here is an example of how to use them:

BOT_GIT_COMMIT_SUBJECT_REGEX_ENABLED="true"
BOT_GIT_COMMIT_SUBJECT_REGEX="^(fix|feat|docs|style|refactor|test|chore|build|ci): .*$"
BOT_GIT_COMMIT_SUBJECT_EXAMPLES_MARKDOWN="* feat: Add authentication module\n* fix: Resolve issue with login not working\n* docs: Update README with installation instructions\n* style: Format code according to the coding guidelines\n* refactor: Extract reusable function for file upload\n* test: Add unit tests for payment processing module\n* build: Upgrade to Node.js version 14.0\n* ci: Update Travis CI configuration for better test coverage\n* chore: Update .gitignore file"

These variables are used to enforce a consistent commit message format for the Git repository. The BOT_GIT_COMMIT_SUBJECT_REGEX_ENABLED is set to "true" to enable the validation of commit subjects using the regular expression pattern specified in BOT_GIT_COMMIT_SUBJECT_REGEX.

The BOT_GIT_COMMIT_SUBJECT_REGEX contains a regular expression pattern that matches commit subjects following the Conventional Commits Specification. This pattern ensures that commit subjects start with a specific type (e.g., "fix", "feat", "docs") followed by a colon and a space, and then any additional description.

The BOT_GIT_COMMIT_SUBJECT_EXAMPLES_MARKDOWN provides a list of example commit subjects following the specified format. These examples can be used as a guideline when writing commit messages.

BOT_GITLAB_MERGE_REQUEST_MILESTONE_REQUIRED

In GitLab, it is necessary to set a milestone when creating a merge request. By default, this requirement is disabled.

BOT_GITLAB_MERGE_REQUEST_ISSUE_REQUIRED

Merge requests can only be merged if the source branch is associated with an existing issue. By default, this requirement is disabled.