Skip to content

Commit 509fa08

Browse files
Remove Change Type template and change label names (#2196)
#### Reference Issues/PRs <!--Example: Fixes #1234. See also #3456.--> #### What does this implement or fix? * Remove template and only rely on manually adding labels with the CI checks failing if none are provided. As discussed here https://github.com/man-group/ArcticDB/pull/2174/files#r1962142382 * Add label names to the existing ones that are used for changelog generation: * `major` or `api break` * `minor` or `enhancement` * `patch` or `bug` * Fix permissions for automatic branch creation * Fix changelog builder not ignoring `rc` releases when comparing to previous release. * Enforced branch protection for the release branch so it is only creatable by admins (and the workflow user's special token) https://github.com/man-group/ArcticDB/settings/rules/3823486 * Fix docs build (remove unsupported option) #### Any other comments? #### Checklist <details> <summary> Checklist for code changes... </summary> - [ ] Have you updated the relevant docstrings, documentation and copyright notice? - [ ] Is this contribution tested against [all ArcticDB's features](../docs/mkdocs/docs/technical/contributing.md)? - [ ] Do all exceptions introduced raise appropriate [error messages](https://docs.arcticdb.io/error_messages/)? - [ ] Are API changes highlighted in the PR description? - [ ] Is the PR labelled as enhancement or bug so it appears in autogenerated release notes? </details> <!-- Thanks for contributing a Pull Request to ArcticDB! Please ensure you have taken a look at: - ArcticDB's Code of Conduct: https://github.com/man-group/ArcticDB/blob/master/CODE_OF_CONDUCT.md - ArcticDB's Contribution Licensing: https://github.com/man-group/ArcticDB/blob/master/docs/mkdocs/docs/technical/contributing.md#contribution-licensing -->
1 parent 74d771d commit 509fa08

8 files changed

+35
-95
lines changed

.github/PULL_REQUEST_TEMPLATE.md

-6
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@
33

44
#### What does this implement or fix?
55

6-
## Change Type (Required)
7-
- [ ] **Patch** (Bug fix or non-breaking improvement)
8-
- [ ] **Minor** (New feature, but backward compatible)
9-
- [ ] **Major** (Breaking changes)
10-
- [ ] **Cherry pick**
11-
126
#### Any other comments?
137

148
#### Checklist

.github/workflows/automated_release.calculate_next_version.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ jobs:
4848
id: get_increment_type
4949
env:
5050
PULL_REQUESTS: ${{ steps.pull_requests.outputs.pull_requests }}
51-
MAJOR_LABEL: major
52-
MINOR_LABEL: minor
53-
PATCH_LABEL: patch
51+
MAJOR_LABEL: "api break"
52+
MINOR_LABEL: "enhancement"
53+
PATCH_LABEL: "bug"
5454
run: |
5555
if [ -z "$PULL_REQUESTS" ]; then
5656
echo "Error: No PRs found between branches" && exit 1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Check Pull Request Labels
2+
on:
3+
pull_request:
4+
types: [opened, labeled, unlabeled, synchronize]
5+
branches: master
6+
jobs:
7+
check_labels:
8+
runs-on: ubuntu-latest
9+
permissions:
10+
issues: write
11+
pull-requests: write
12+
steps:
13+
- uses: mheap/github-action-required-labels@v5
14+
with:
15+
mode: exactly
16+
count: 1
17+
labels: |
18+
patch
19+
minor
20+
major
21+
add_comment: true

.github/workflows/automated_release.create_release_branch.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,16 @@ jobs:
3333
create-next-release-branch:
3434
needs: [calculate-next-version, get-master-sha]
3535
runs-on: ubuntu-latest
36+
environment: TestPypi # For the branch restrictions token
37+
permissions:
38+
contents: write
3639
outputs:
3740
new_branch: ${{ needs.calculate-next-version.outputs.version }}
3841
steps:
3942
- name: Create branch ${{ needs.calculate-next-version.outputs.version }} from ${{ needs.get-master-sha.outputs.sha }}
4043
uses: peterjgrainger/[email protected]
4144
env:
42-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
45+
GITHUB_TOKEN: ${{ secrets.TAGGING_TOKEN }}
4346
with:
4447
branch: ${{ needs.calculate-next-version.outputs.version }}
4548
sha: ${{ needs.get-master-sha.outputs.sha }}

.github/workflows/automated_release.parse_pr_template.yml

-81
This file was deleted.

.github/workflows/publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848

4949
- id: changelog
5050
name: Release Changelog Builder
51-
uses: mikepenz/release-changelog-builder-action@v3.7.3
51+
uses: mikepenz/release-changelog-builder-action@v5
5252
env:
5353
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5454
with:

build_tooling/change_log.json

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
{
22
"categories": [
3+
{
4+
"title": "## ⚠️ Breaking Changes",
5+
"labels": ["api break", "major"]
6+
},
37
{
48
"title": "## 🚀 Features",
5-
"labels": ["enhancement"]
9+
"labels": ["enhancement", "minor"]
610
},
711
{
812
"title": "## 🐛 Fixes",
9-
"labels": ["bug"]
13+
"labels": ["bug", "patch"]
1014
}
1115
],
1216
"pr_template": "- ${{TITLE}} (#${{NUMBER}})",

docs/mkdocs/mkdocs.yml

-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ plugins:
6464
group_by_category: true
6565
docstring_options:
6666
ignore_init_summary: false
67-
allow_section_blank_line: true
6867
docstring_section_style: spacy
6968
heading_level: 2
7069
inherited_members: true

0 commit comments

Comments
 (0)