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

chore: adding docs conventional commit, adapt conditional labeling #3267

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all 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
8 changes: 7 additions & 1 deletion .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,14 @@ jobs:
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
const PR_TITLE_PREFIX = 'docs:';
const LABEL_NAME = 'documentation';
const DOC_PATH_PREFIX = 'docs/';

const prTitle = context.payload.pull_request.title;
const labels = context.payload.pull_request.labels.map(label => label.name);
if (labels.includes('documentation')) {

if (labels.includes(LABEL_NAME) || prTitle.startsWith(PR_TITLE_PREFIX)) {
return true;
}

Expand Down
1 change: 1 addition & 0 deletions .github/workflows/pull-request-title.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ jobs:
fix
feat
chore
docs
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
- `feat:` - This should be the most used type, as most work we are doing in the project are new features. Commits using this type will always show up in the Changelog.
- `fix:` - When fixing a bug, we should use this type. Commits using this type will always show up in the Changelog.
- `chore:` - The least used type, these are __not__ included in the Changelog unless they are breaking changes. But remain useful for an understandable commit history.
- `docs` - If your changes are only on the docs, use this type

### Conventional Commits: Breaking Changes

Expand Down Expand Up @@ -229,4 +230,4 @@
* **optimizer:** Compile Boolean to u1
```

[^1]: Currently, @critesjosh, @catmcgee and @signorecello. For Noir documentation, it is recommended to tag @signorecello

Check warning on line 233 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Spellcheck / Spellcheck

Unknown word (critesjosh)

Check warning on line 233 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Spellcheck / Spellcheck

Unknown word (catmcgee)

Check warning on line 233 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Spellcheck / Spellcheck

Unknown word (signorecello)

Check warning on line 233 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / Spellcheck / Spellcheck

Unknown word (signorecello)
Loading