bb publishYou are a maintainer of this project.
Is invoked from the command line via:
bb publishThe publish task locally validates:
local git
you are not on a fork
you are on the default branch
do not have any uncommitted code
do not have any unpushed commits
local head sha matches matches remote head sha
changelog
Has an "Unreleased" section with content
to run these validations without publishing, run bb pubcheck
|
Then also locally:
bumps the version <release count> (our scheme is major.minor.<release count>)
Our version is stored in deps.edn under :aliases :neil :project :version
applies version to:
doc/01-user-guide.adoc
CHANGELOG.adoc
git commits: deps.edn doc/01-user-guide.adoc CHANGELOG.adoc
git tags with release tag v<version>
pushes commit
pushes tag
Then up on CI, the CI publish workflow is only triggered when it sees a release tag:
CI tests workflow is invoked
a release jar is published to clojars
a GitHub release is created
cljdoc is informed of the new release
Scripts:
bb.edn - tasks entry point
script/publish.clj - client side work
script/ci_publish.clj - ci side work
CI - We use GitHub Actions for this project
.github/workflows/publish.yml
Clojars secrets are protected under the publish environment which is only referenced by publish.yml.
Codecov.io token is configured as a CODECOV_TOKEN secret in this repo.
Token was generated and populated by clj-commons GitHub org admins who have the privs to do such things.
Hit them up in Clojurians Slack #clj-commons channel if you should ever need their help.
When publishing, you will see both the tests workflow triggered and the publish workflow triggered (which also invokes the tests workflow).
This extra running of the tests workflow is GitHub Actions responding to changes committed as part of the publishing work.
Annoying, but harmless.
Can you improve this documentation? These fine people already did:
lread & Lee ReadEdit on GitHub
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |