How to use Github Release Version Number in Github Action

Question

I have created a Github repo that has got an action to build the npm package and publish it to npmjs.com. The trigger for my action is the creation of a new release in Github. When creating the new release, Github is asking me for a version number. I would love to use this version number in the Action and provide it to the yarn publish command.

My ci-file looks like this (i stripped some parts that are not important here):

name: Deploy npm package

on:
  release:
    types: [created]

jobs:
  publish-npm:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          node-version: 12
          registry-url: https://registry.npmjs.org/
      - run: yarn install
      - run: yarn build
      - run: yarn publish --new-version ${...}
        env:a
          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

Is there an environmental variable that contains the version number from the release?

scthi · Accepted Answer · 2019-12-29 16:24:01Z

60

It should be ${{ github.event.release.tag_name }}. The structure of a release can be found here: https://developer.github.com/v3/repos/releases/#get-a-single-release

I'd also suggest to use

on:
  release:
    types: [published]

instead of created to avoid putting something to npm for draft releases. See: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#release-event-release

Hint:

To debug the event you can use:

jobs:
  debug:
    name: Debug
    runs-on: ubuntu-latest
    steps:
      - name: Dump env
        run: env | sort
      - name: Dump GitHub context
        env:
          GITHUB_CONTEXT: ${{ toJson(github) }}
        run: echo "$GITHUB_CONTEXT"

answered Dec 29, 2019 at 16:24

scthi

2,5111 gold badge20 silver badges14 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Woozar Over a year ago

It looks pretty sophisticated. I will check it tomorrow and mark it as answer if it works.

Roemer Over a year ago

Isn't published also fired for drafts and only created only used for non-draft releases?

Manav Over a year ago

Thank you @scthi, dumping the GitHub context helped!

colidyre · Accepted Answer · 2020-04-21 01:13:46Z

23

You can get tag version using ${{ github.event.release.tag_name }}.

edited Apr 21, 2020 at 1:13

colidyre

4,87512 gold badges46 silver badges65 bronze badges

answered Apr 20, 2020 at 18:29

milind

2312 silver badges2 bronze badges

1 Comment

marcelosalloum Over a year ago

Here's the reference with all information you can get from the webhooks that trigger GH Actions: docs.github.com/en/developers/webhooks-and-events/webhooks/…

Collectives™ on Stack Overflow

How to use Github Release Version Number in Github Action

2 Answers 2

3 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related