lpenz/ghaction-version-gen repository overview

⁠ghaction-version-gen

ghaction-version-gen is a docker github action that outputs a version number for you to use in a deploy action.

There are many ways to generate version information for a repository. They usually involve processing GITHUB_REF in some way⁠, maybe using even using github-script⁠.

This repository is also an example of how to create a docker github action that compiles a rust entrypoint in a container and then moves it to a second, minimal container.

⁠Outputs

The following are the primary outputs of this action, usually the ones used for versioning:

• version_tagged: for repositories that should only deploy on tags, it's defined if the github event was a push of a tag.

  The output itself is the tag, with the optional v stripped.

• version_commit: for repositories that deploy on all commits to master or main, it's defined if the github event was a push to one of those.

  The output itself is the most recent tag on the branch, with the optional v stripped, followed by the distance between the branch and the tag.

The idea of this scheme is to allow the user to check if version_tagged or version_commit is not empty, and in this case use it as the version being deployed:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - id: version
        uses: docker://lpenz/ghaction-version-gen:0.3
      - name: deploy
        uses: <deploy action>
        if: steps.version.outputs.version_tagged != ''
        with:
          version: ${{ steps.version.outputs.version_tagged }}

The same thing works for version_commit. Just keep in mind that, for it to work on a tagged commit, you may have to push the tag before the commit, which is counter-intuitive.

⁠Secondary outputs

These are the secondary outputs that might be useful for debugging or as alternative versioning schemes:

• is_push: if the github event was identified, "true" if the event was a push or "false" otherwise.
• is_tag: if the github ref was identified, "true" if the ref is a tag, false otherwise.
• is_main: "true" if the github ref was for a branch named main or master.
• is_push_tag: "true" if a tag was pushed.
• is_push_main: "true" if main or master were pushed.
• commit: the hash of the commit.
• git_describe_tags: the output of git describe --tags
• tag_latest: the most recent tag.
• distance: the distance between the current commit and tag_latest.
• tag_distance: tag_latest-distance
• tag_head: the tag on HEAD, if there's a tag on HEAD (does not depend on the gitub event).
• dash_distance: - prepended to distance
• tag_latest_ltrimv: tag_latest without the optional leading v.
• tag_head_ltrimv: tag_head without the optionsl leading v, if tag_head was defined.
• version_tagged: tag_head_ltrimv if is_push_tag.
• version_commit: tag_distance_ltrimv if is_push_main.