Skip to content

How to release

Erik Martin-Dorel edited this page Aug 11, 2021 · 7 revisions

Like all other GitHub Actions, docker-coq-action follows some Git flow − with master as developing branch, and v1 (resp. v2…) as release branch(es), assuming v1 / v1.x.y follow semantic versioning.

(As an aside, the v1 git reference is implemented as a branch, rather than a "moving tag", to be closer to standard Git conventions.)

Steps to be done by the maintainers

  • Merge the PRs in master

  • Release the tag (assuming it is v1.1.0) from your local machine:

    cd .../docker-coq-action
    git checkout master
    git pull  # should be fast-forward
    
    git tag -n  # inspect the existing tags
    git tag -s v1.1.0 -m v1.1.0
    gitk
    
    git checkout v1
    git pull  # should be fast-forward
    git merge master  # should be fast-forward
    git diff v1.1.0..HEAD
    gitk
    
    git push origin v1.1.0
    git push -n
    git push
    
  • Make a GitHub release, following somewhat this template:

    docker-coq-action v1.2.0

    Bugfix:
    * Prepend 'exec 2>&1' to custom_script to untangle output (PR #32 by @erikmd)
    
    Documentation:
    * Add sudo-chown example & fail-fast remark (PR #30 by @erikmd)
    
    New Features:
    * Add feature to export env variables (PR #31 by @erikmd)
    * Split custom_script to enhance the customization experience (PR #33 by @erikmd)
      → custom_script now interpolates `{{before_install}}, {{install}}, {{after_install}}, {{before_script}}, {{script}}, {{after_script}}, {{uninstall}}`
    
    **Changelog:** https://github.com/coq-community/docker-coq-action/compare/v1.1.0...v1.2.0 − **Refman:** [`v1.2.0`](https://github.com/coq-community/docker-coq-action/tree/v1.2.0#readme)
    
Clone this wiki locally