bb ci-release validate
Notes for project maintainers.
The release workflow is handled by our Release GitHub Action.
Fail fast if:
Change log not ready
Bump version.edn
for release version
Create thin jar using release version
Apply release version to the following docs:
user guide for usage examples
change log "unreleased" heading
Deploy jar to clojars
Commit changes made to docs and version.edn
Create and push a release tag back to the project repo
Inform cljdoc of the new release
At this time, the release workflow does not run tests. The assumption is that you’ve waited for the last CI test run to complete and are happy with the results. |
Release num is bumped automatically by release workflow.
Edit major
and minor
by editing version.edn
in the project root.
To check if things seeem ready:
bb ci-release validate
If you want to run everything up to, but not including, commit and push:
bb ci-release prep
You will NOT want to check in changes made by prep .
|
GitHub has been configured with necessary secrets for GitHub Actions to deploy to clojars.
As a maintainer you should have sufficient privileges to see a "Run Workflow" dropdown button on the Release action page. The dropdown will prompt for a branch. I did not see a way to disable this prompt, simply leave it at "master" and run the workflow.
Don’t forget to pull after a release to get the changes made by the release workflow. |
Can you improve this documentation? These fine people already did:
Lee Read & lreadEdit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close