Skip to content

Commit 2cb260b

Browse files
committed
Support release please
1 parent 3c9d2e2 commit 2cb260b

4 files changed

Lines changed: 112 additions & 0 deletions

File tree

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Release Please
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- main
8+
9+
permissions:
10+
contents: write
11+
pull-requests: write
12+
13+
jobs:
14+
release-please:
15+
name: Release Please
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Release Please
20+
uses: googleapis/release-please-action@v4
21+
with:
22+
token: ${{ secrets.GITHUB_TOKEN }}
23+
config-file: release-please-config.json
24+
manifest-file: .release-please-manifest.json

.release-please-manifest.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "4.1.0"
3+
}

AGENTS.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,3 +399,57 @@ Integration tests can use real Azure Service Bus if connection strings are provi
399399
- Main branch: `master`
400400
- Active development may occur on feature branches
401401
- CI runs on `master`, `main`, and pull requests
402+
403+
### Commit Message Convention
404+
405+
This project uses [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning via Release Please. Commit messages must follow this format:
406+
407+
```
408+
<type>[optional scope]: <description>
409+
410+
[optional body]
411+
412+
[optional footer(s)]
413+
```
414+
415+
**Types that trigger version bumps:**
416+
417+
| Type | Description | Version Bump |
418+
|------|-------------|--------------|
419+
| `feat` | New feature | Minor (4.1.0 → 4.2.0) |
420+
| `fix` | Bug fix | Patch (4.1.0 → 4.1.1) |
421+
| `feat!` or `fix!` | Breaking change (note the `!`) | Major (4.1.0 → 5.0.0) |
422+
423+
**Types that do NOT trigger version bumps:**
424+
425+
- `docs` - Documentation changes
426+
- `style` - Formatting, whitespace
427+
- `refactor` - Code restructuring without behavior change
428+
- `perf` - Performance improvements
429+
- `test` - Adding or updating tests
430+
- `build` - Build system or dependencies
431+
- `ci` - CI/CD configuration
432+
- `chore` - Other maintenance tasks
433+
434+
**Examples:**
435+
436+
```bash
437+
feat: add Azure Storage Queue subscriber support
438+
fix: correct SAS token validation for special characters
439+
feat!: change configuration schema for multi-topic setup
440+
docs: update README with Docker instructions
441+
chore: update NuGet dependencies
442+
```
443+
444+
### Release Process
445+
446+
Releases are automated via Release Please:
447+
448+
1. Push commits to `master` using conventional commit messages
449+
2. Release Please creates/updates a "Release PR" with changelog
450+
3. Merge the Release PR to trigger:
451+
- Git tag creation (e.g., `4.2.0`)
452+
- GitHub Release with generated changelog
453+
- NuGet package publish
454+
- Docker image build and push
455+
- Platform binaries upload

release-please-config.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
3+
"release-type": "simple",
4+
"include-component-in-tag": false,
5+
"include-v-in-tag": false,
6+
"bump-minor-pre-major": true,
7+
"bump-patch-for-minor-pre-major": true,
8+
"draft": false,
9+
"prerelease": false,
10+
"packages": {
11+
".": {
12+
"package-name": "AzureEventGridSimulator",
13+
"changelog-path": "CHANGELOG.md",
14+
"extra-files": []
15+
}
16+
},
17+
"changelog-sections": [
18+
{ "type": "feat", "section": "Features" },
19+
{ "type": "fix", "section": "Bug Fixes" },
20+
{ "type": "perf", "section": "Performance Improvements" },
21+
{ "type": "deps", "section": "Dependencies" },
22+
{ "type": "revert", "section": "Reverts" },
23+
{ "type": "docs", "section": "Documentation", "hidden": true },
24+
{ "type": "style", "section": "Styles", "hidden": true },
25+
{ "type": "chore", "section": "Miscellaneous Chores", "hidden": true },
26+
{ "type": "refactor", "section": "Code Refactoring", "hidden": true },
27+
{ "type": "test", "section": "Tests", "hidden": true },
28+
{ "type": "build", "section": "Build System", "hidden": true },
29+
{ "type": "ci", "section": "Continuous Integration", "hidden": true }
30+
]
31+
}

0 commit comments

Comments
 (0)