Liking cljdoc? Tell your friends :D

Maintainer Guide

Introduction

Notes for project maintainers.

Release Workflow

The release workflow is handled by our Release GitHub Action.

  1. Fail fast if:

    1. Change log not ready

  2. Bump version.edn for release version

  3. Create thin jar using release version

  4. Apply release version to the following docs:

    1. user guide for usage examples

    2. change log "unreleased" heading

  5. Deploy jar to clojars

  6. Commit changes made to docs and version.edn

  7. Create and push a release tag back to the project repo

  8. 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.

Updating the Version

Release num is bumped automatically by release workflow.

Edit major and minor by editing version.edn in the project root.

Local Verification

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.

Special Setup

GitHub has been configured with necessary secrets for GitHub Actions to deploy to clojars.

Invoking

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.
❮Code of Conduct

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

Keyboard shortcutsReport a problemcljdoc on GitHub
× close