manver-action

Extract version metadata

Contents

• What is this?
• Use
• Inputs
  • branch
  • build
  • manifest
  • property
  • release-branch-prefix
  • tag-prefix
• Outputs
  • build
  • manifest
  • tag
  • tag-build
• Related
• Contribute

What is this?

This is a simple action for extracting version metadata.

Use

---
name: ci
on:
  - pull_request
  - push
  - workflow_dispatch
jobs:
  preflight:
    runs-on: ubuntu-latest
    outputs:
      version: ${{ steps.version.outputs.build }}
    steps:
      - id: checkout
        name: Checkout ${{ github.head_ref || github.ref_name }}
        uses: actions/checkout@v5.0.0
        with:
          persist-credentials: false
          ref: ${{ github.head_ref || github.ref }}
      - id: version
        name: Extract version metadata
        uses: flex-development/manver-action@1.1.0

Inputs

branch

default: ${{ github.head_ref || github.ref_name }}

The name of the branch to check when generating a build version (optional).

build

default: ${{ github.event.pull_request.head.sha || github.sha }}

Build metadata (optional).

manifest

default: package.json

The path to the manifest file (optional).

Manifest files are expected to be compatible with jq.

property

default: .version

Version property path in manifest file (optional).

release-branch-prefix

default: release/

The prefix used to mark release branches (optional).

Build versions generated from release branches will not have metadata attached.

tag-prefix

The prefix to prepend when generating release tags (optional).

Outputs

build

Build version (generated from outputs.manifest and inputs.build).

manifest

The value of property in the manifest file.

tag

Release tag generated from manifest version.

tag-build

Release tag generated from build version.

Related

• flex-development/gh-release-url-action — create a url for a github release
• flex-development/ghr-url-action — create a url for a github registry
• flex-development/jq-action — execute json queries with jq
• flex-development/npm-url-action — create a url for the npm registry

Contribute

See CONTRIBUTING.md.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.