Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Github action to verify format of PR titles. #7463

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/workflows/pr-title-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: PR Title Lint

on:
pull_request:
types: [opened, edited, synchronize]

jobs:
pr-title-check:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '14'

- name: Run PR title linter
run: |
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
Comment on lines +21 to +26
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not the format of pull request titles in Thanos. 🤔

fi
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,32 @@ It is a good practice to keep your branch updated by rebasing your branch to mai
* If you feel like your PR is waiting too long for a review, feel free to ping the [`#thanos-dev`](https://slack.cncf.io/) channel on our slack for a review!
* If you are a new contributor with no write access, you can tag in the respective maintainer for the changes, but be patient enough for the reviews. *Remember, good things take time :)*

### 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.

Comment on lines +188 to +213
Copy link
Contributor

@douglascamata douglascamata Jun 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

### Dependency management

The Thanos project uses [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage dependencies on external packages. This requires a working Go environment with version 1.11 or greater and git installed.
Expand Down
Loading