Skip to content

Commit 12812c6

Browse files
Copilotbrunoborges
andcommitted
docs: document release process in copilot instructions
Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>
1 parent 41a65f8 commit 12812c6

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,3 +249,23 @@ This SDK is designed to be **lightweight with minimal dependencies**:
249249
6. **Commit**: Make focused commits with clear messages
250250
7. **Push**: Push your branch and create a PR
251251
8. **Review**: Address review feedback and iterate
252+
253+
## Release Process
254+
255+
The release process is automated via the `publish-maven.yml` GitHub Actions workflow. Key steps:
256+
257+
1. **CHANGELOG Update**: The script `.github/scripts/update-changelog.sh` automatically:
258+
- Converts the `## [Unreleased]` section to `## [version] - date`
259+
- Creates a new empty `## [Unreleased]` section at the top
260+
- Updates version comparison links at the bottom of CHANGELOG.md
261+
262+
2. **Documentation Updates**: README.md and jbang-example.java are updated with the new version
263+
264+
3. **Maven Release**: Uses `maven-release-plugin` to:
265+
- Update pom.xml version
266+
- Create a git tag
267+
- Deploy to Maven Central
268+
269+
4. **Rollback**: If the release fails, the documentation commit is automatically reverted
270+
271+
The workflow is triggered manually via workflow_dispatch with optional version parameters.

0 commit comments

Comments
 (0)