Skip to content

Commit 77035cc

Browse files
BYKBYK
authored
chore(ci): Improve Craft config with title stripping and artifact filtering (#5444)
## Summary - Add named regex capture groups to `commit_patterns` in `.github/release.yml` for Craft's [title stripping](https://craft.sentry.dev/configuration/#title-stripping-default-behavior) feature - Remove the CI `merge` job by switching to Craft 2.21.1's [workflow-scoped artifact filtering](https://craft.sentry.dev/configuration/#github-artifact-provider-configuration) (same approach as getsentry/cli#215) - Modernize `.craft.yml` changelog config to object format - Modernize `scripts/bump-version.sh` to use Craft env vars ## Changes ### `.github/release.yml` - All `commit_patterns` now use `(?<type>...)` and `(?<scope>...)` named capture groups so Craft strips conventional commit prefixes from changelog entries - Added **Breaking Changes** category (`semver: major`) from Craft defaults - Expanded Internal Changes patterns to include `refactor|meta|perf` from Craft defaults ### `.craft.yml` - Bumped `minVersion` from `2.17.0` to `2.21.1` - Added `artifactProvider` config to fetch `artifact-*` directly from `ci.yml` workflow - Modernized changelog from separate keys to object format - Added explicit `preReleaseCommand` (was relying on the implicit default) ### `.github/workflows/ci.yml` - Removed the `merge` job (no longer needed with Craft 2.21.1 artifact filtering) - Removed `compression-level: '0'` from upload steps (was only needed for merging) ### `scripts/bump-version.sh` - Use `CRAFT_OLD_VERSION` / `CRAFT_NEW_VERSION` env vars instead of positional arguments (recommended by Craft docs)
1 parent 1eeb5df commit 77035cc

File tree

4 files changed

+25
-32
lines changed

4 files changed

+25
-32
lines changed

‎.craft.yml‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
minVersion: 2.17.0
1+
minVersion: 2.21.1
2+
preReleaseCommand: bash scripts/bump-version.sh
23
targets:
34
- name: pypi
45
includeNames: /^sentry[_\-]sdk.*$/
@@ -30,5 +31,12 @@ targets:
3031
license: MIT
3132
- name: sentry-pypi
3233
internalPypiRepo: getsentry/pypi
33-
changelog: CHANGELOG.md
34-
changelogPolicy: auto
34+
artifactProvider:
35+
name: github
36+
config:
37+
artifacts:
38+
CI:
39+
- 'artifact-*'
40+
changelog:
41+
filePath: CHANGELOG.md
42+
policy: auto

‎.github/release.yml‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,37 @@ changelog:
55
authors:
66
- dependabot
77
categories:
8+
- title: Breaking Changes 🛠
9+
commit_patterns:
10+
- "^(?<type>\\w+(?:\\((?<scope>[^)]+)\\))?!:\\s*)"
11+
semver: major
812
- title: New Features ✨
913
labels:
1014
- "Changelog: Feature"
1115
commit_patterns:
12-
- "^feat\\b"
16+
- "^(?<type>feat(?:\\((?<scope>[^)]+)\\))?!?:\\s*)"
1317
semver: minor
1418
- title: Bug Fixes 🐛
1519
labels:
1620
- "Changelog: Bugfix"
1721
commit_patterns:
18-
- "^(fix|bugfix)\\b"
22+
- "^(?<type>(?:fix|bugfix)(?:\\((?<scope>[^)]+)\\))?!?:\\s*)"
1923
semver: patch
2024
- title: Deprecations 🏗️
2125
labels:
2226
- "Changelog: Deprecation"
2327
commit_patterns:
24-
- "deprecat" # deprecation, deprecated
28+
- "^(?<type>deprecat(?:ion|ed|e)(?:\\((?<scope>[^)]+)\\))?!?:?\\s*)"
2529
semver: patch
2630
- title: Documentation 📚
2731
labels:
2832
- "Changelog: Docs"
2933
commit_patterns:
30-
- "^docs?\\b"
34+
- "^(?<type>docs?(?:\\((?<scope>[^)]+)\\))?!?:\\s*)"
3135
semver: patch
3236
- title: Internal Changes 🔧
3337
labels:
3438
- "Changelog: Internal"
3539
commit_patterns:
36-
- "^(build|ref|chore|ci|tests?)\\b"
40+
- "^(?<type>(?:build|refactor|meta|chore|ci|ref|perf|tests?)(?:\\((?<scope>[^)]+)\\))?!?:\\s*)"
3741
semver: patch

‎.github/workflows/ci.yml‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,6 @@ jobs:
6161
path: |
6262
dist/*
6363
if-no-files-found: 'error'
64-
# since this artifact will be merged, compression is not necessary
65-
compression-level: '0'
6664

6765
docs:
6866
name: Build SDK API Doc
@@ -85,17 +83,3 @@ jobs:
8583
path: |
8684
docs/_build/gh-pages.zip
8785
if-no-files-found: 'error'
88-
# since this artifact will be merged, compression is not necessary
89-
compression-level: '0'
90-
91-
merge:
92-
name: Create Release Artifact
93-
runs-on: ubuntu-latest
94-
needs: [build_lambda_layer, docs]
95-
steps:
96-
- uses: actions/upload-artifact/merge@v6
97-
with:
98-
# Craft expects release assets from github to be a single artifact named after the sha.
99-
name: ${{ github.sha }}
100-
pattern: artifact-*
101-
delete-merged: true

‎scripts/bump-version.sh‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,15 @@ fi
99
SCRIPT_DIR="$( dirname "$0" )"
1010
cd $SCRIPT_DIR/..
1111

12-
OLD_VERSION="${1}"
13-
NEW_VERSION="${2}"
14-
15-
echo "Current version: $OLD_VERSION"
16-
echo "Bumping version: $NEW_VERSION"
12+
echo "Current version: $CRAFT_OLD_VERSION"
13+
echo "Bumping version: $CRAFT_NEW_VERSION"
1714

1815
function replace() {
1916
! grep "$2" $3
2017
perl -i -pe "s/$1/$2/g" $3
2118
grep "$2" $3 # verify that replacement was successful
2219
}
2320

24-
replace "version=\"$OLD_VERSION\"" "version=\"$NEW_VERSION\"" ./setup.py
25-
replace "VERSION = \"$OLD_VERSION\"" "VERSION = \"$NEW_VERSION\"" ./sentry_sdk/consts.py
26-
replace "release = \"$OLD_VERSION\"" "release = \"$NEW_VERSION\"" ./docs/conf.py
21+
replace "version=\"$CRAFT_OLD_VERSION\"" "version=\"$CRAFT_NEW_VERSION\"" ./setup.py
22+
replace "VERSION = \"$CRAFT_OLD_VERSION\"" "VERSION = \"$CRAFT_NEW_VERSION\"" ./sentry_sdk/consts.py
23+
replace "release = \"$CRAFT_OLD_VERSION\"" "release = \"$CRAFT_NEW_VERSION\"" ./docs/conf.py

0 commit comments

Comments
 (0)