Skip to content

bbonkr/get-version-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Get version action

This is an action to get the version string from project file such as package.json, .csproj (c# sdk style project file)

Usages

steps:
  - name: Checkout
    uses: actions/checkout@v4

  - uses: bbonkr/get-version-action@v1
    id: get_version
    with:
      project: './package.json'
      show_log_message: true
  - name: logging
    run: |
      echo "version=${{ steps.get_version.outputs.version }}"
      echo "major=${{ steps.get_version.outputs.major }}"
      echo "minor=${{ steps.get_version.outputs.minor }}"
      echo "patch=${{ steps.get_version.outputs.patch }}"
      echo "pre-release=${{ steps.get_version.outputs.pre-release }}"
      echo "build=${{ steps.get_version.outputs.build }}"

Inputs

Name Required Description
project Your project file path. Support package.json, .csproj (c# sdk style project file)
show_log_message Show message or not in the console. Shows error log always even set false. Value has to be true or something else;

Support file

  • package.json
  • .csproj (c# sdk style project file)

Outputs

Name Description
version version string, If does not find version string, throws exception.
major major of version (SEMVER1)
minor minor of version (SEMVER1)
patch patch of version (SEMVER1)
pre-release pre-release of version (SEMVER1)
build build of version (SEMVER1)

e.g.) input: v1.2.3-pre.4+5

outputs: version: v1.2.3-pre.4+5 major: 1 minor: 2 patch: 3 pre-release: pre.4 build: 5

Footnotes

  1. https://semver.org/ 2 3 4 5