Skip to content

Commit 7b4741c

Browse files
authored
Add release process documentation (#12)
1 parent f053d3a commit 7b4741c

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,10 @@ make build # Build the package
5151
make clean # Clean build artifacts
5252
make help # Show all available targets
5353
```
54+
55+
## Release Process (for Maintainers)
56+
57+
1. **Run Release PR Workflow:** After merging a Pull Request with `changie` changes, [trigger the "changie release PR" GitHub Actions workflow](https://github.com/deltastreaminc/deltastream-connector-python/actions/workflows/changie_generate_release_pr.yml).
58+
2. **Review Generated PR:** Wait for the workflow to complete. It will generate a new Pull Request ([in the repository PRs](https://github.com/deltastreaminc/deltastream-connector-python/pulls)) with the updated changelog and version bump. Review this PR.
59+
3. **Changelog release:** The changie release will automatically update the changelog file and push the releases in Github.
60+
4. **Pypi Release:** [The Pypi release workflow](https://github.com/deltastreaminc/deltastream-connector-python/actions/workflows/release.yml) will then be triggered. An approval will be required to proceed with publishing the new version of the adapter to the public repository.

0 commit comments

Comments
 (0)