olegtarasov / get-tag Goto Github PK

A GitHub action that gets current tag name and puts it into an environment variable

License: MIT License

TypeScript 26.89% JavaScript 73.11%

get-tag's Introduction

Get tag name

This action gets tag name from commit that triggered the action and puts it into an environment variable GIT_TAG_NAME. It will also export is as an output named "tag".

You can also use optional parameters tagRegex and tagRegexGroup to extract a part from tag string.

Usage

Dead simple:

    steps:
      - uses: olegtarasov/[email protected]
        id: tagName
        with:
          tagRegex: "foobar-(.*)"  # Optional. Returns specified group text as tag name. Full tag string is returned if regex is not defined.
          tagRegexGroup: 1 # Optional. Default is 1.
      - name: Some other step # Output usage example
        with:
          tagname: ${{ steps.tagName.outputs.tag }}
      - name: Yet another step # Environment variabl usage example
        run: |
          docker build . --file Dockerfile --tag docker.pkg.github.com/someimage:$GIT_TAG_NAME

You can also use named regex groups (thanks to PR from @jelgblad):

    steps:
      - uses: olegtarasov/[email protected]
        id: tagName
        with:
          tagRegex: "(?<package>.*)-(?<version>.*)" 
      - name: Some other step # Output usage example
        with:
          dirname: ${{ steps.tagName.outputs.package }}
          tagname: ${{ steps.tagName.outputs.version }}

get-tag's People

Contributors

Stargazers

Watchers

Forkers

jwalton frankfoerster adventurebyte nativeinstruments jelgblad yannickjadoul zendesk little-core-labs scraye axuall ceramic-engine m-e-p-inc people-vox zhangdi12202023 cipherstash

get-tag's Issues

Error: Unable to process command '##[set-env name=GIT_TAG_NAME;]stage-v1' successfully.

Using

 - name: Get tag name
        uses: olegtarasov/get-tag@v2

fails with

Error: Unable to process command '##[set-env name=GIT_TAG_NAME;]stage-v1' successfully.
Error: The `set-env` command is disabled. Please upgrade to using Environment Files or opt into unsecure command execution by setting the `ACTIONS_ALLOW_UNSECURE_COMMANDS` environment variable to `true`. For more information see: https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands/
Warning: The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

Update to newer node version

While using the action I got this warning:

Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16: AButler/[email protected].
For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/.

Create a new release for Node.js 20+

I get the following warning about v2.1.2 of this action:

Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: olegtarasov/[email protected]. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.

Could you please make a new release with a newer version of Node.js?

Specify expected inputs in action.yml

Thanks for creating this action! It's very useful when you want to get tag name on all 3 major operating systems.

When using this action, I've noticed that it produces warning:

##[warning]Unexpected input(s) 'tagRegex', 'tagRegexGroup', valid inputs are ['']

Most likely the reason for this is that action.yml file specifies only outputs but not inputs. I believe, if you specify inputs, the warning will disappear.

I found some docs on action inputs:

https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs

Null output...

So, just trying this for the first time. There is no output.

feature request: option to strip leading `v`

It's pretty common for git tags to have a leading v prefix on the version number. However, it's equally common (and in the case of needing this very action, I'd say exceedingly likely) that one may need or prefer the version name without the leading v.

It would be great if there were an option (default to whatever makes sense to you) that would automatically strip any leading v when returning the tag name.

GITHUB_TAG_NAME is an invalid env var name

The github actions docs indicate that the GITHUB_ prefix for env vars is reserved.

https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#naming-conventions

Note: GitHub reserves the GITHUB_ environment variable prefix for internal use by GitHub. Setting an environment variable or secret with the GITHUB_ prefix will result in an error.

Create a new release for Node.js 16+

I get the following warning about v2.1.1 of this action:

Node.js 12 actions are deprecated. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. Please update the following actions to use Node.js 16: olegtarasov/get-tag

Could you please make a new release with a newer version of Node.js?

Latest version tag missing 'v'

Hello!

This workflow broke for me today when I updated it. I realized it was because I updated it to v2.1.3, but your latest tag is just 2.1.3.

When you have time, can you please create a new release tag to match github actions patterns and your old tags?

Thank you for you work on this!