feat: Github action to verify format of PR titles. #7463
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: ayushrakesh <ayushrakesh.05@gmail.com>
Signed-off-by: ayushrakesh <ayushrakesh.05@gmail.com>
feat: Github action to check PR's title format.
douglascamata
suggested changes
Jun 19, 2024
Comment on lines
+21
to
+26
| TITLE=$(jq -r .pull_request.title "$GITHUB_EVENT_PATH") | ||
| if [[ ! "$TITLE" =~ ^(fix|feat|docs|style|refactor|perf|test|chore):\ .{1,50}$ ]]; then | ||
| echo "Invalid PR title: $TITLE" | ||
| echo "PR titles must start with one of the following types: fix, feat, docs, style, refactor, perf, test, chore." | ||
| echo "Followed by a colon and space, and a brief description (1-50 characters)." | ||
| exit 1 |
There was a problem hiding this comment.
This is not the format of pull request titles in Thanos. 🤔
Comment on lines
+188
to
+213
| ### Pull Request Guidelines | ||
|
|
||
| To ensure a consistent and meaningful naming convention for pull requests (PRs), please follow these guidelines: | ||
|
|
||
| #### PR Title Format | ||
|
|
||
| PR titles should follow this pattern: | ||
| - `type: brief description` | ||
|
|
||
| Where `type` is one of the following: | ||
| - `fix`: A bug fix | ||
| - `feat`: A new feature | ||
| - `docs`: Documentation changes | ||
| - `style`: Code style changes (formatting, missing semi-colons, etc.) | ||
| - `refactor`: Code refactoring without changing functionality | ||
| - `perf`: Performance improvements | ||
| - `test`: Adding or updating tests | ||
| - `chore`: Maintenance tasks (dependency updates, tool changes, etc.) | ||
|
|
||
| #### Examples | ||
| - `fix: Correct typo in README` | ||
| - `feat: Add new storage backend support` | ||
| - `docs: Update contributing guidelines` | ||
|
|
||
| Failure to follow this convention will result in a failing check on your PR. | ||
|
|
There was a problem hiding this comment.
This is wrong. The pull request guidelines are included in the pull request template: https://raw.githubusercontent.com/thanos-io/thanos/main/.github/PULL_REQUEST_TEMPLATE.md
|
@douglascamata I have raised another PR for it. Please review it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added Github action to check the titles of pull requests are properly formatted.
Changelog entry format:
- #7463 Thanos github-workflows ...
Changes
Added one yaml file to implement the same and modify CONTRIBUTING.md file to illustrate valid pull requests title's format.
Verification
I have tested it with some test PR in my repo.