https://github.com/flex-development/dist-tag-action
Distribution tag lookup utility for GitHub Actions
https://github.com/flex-development/dist-tag-action
dist-tag github-action npm-dist-tag npm-publish typescript
Last synced: 4 months ago
JSON representation
Distribution tag lookup utility for GitHub Actions
- Host: GitHub
- URL: https://github.com/flex-development/dist-tag-action
- Owner: flex-development
- License: bsd-3-clause
- Created: 2022-08-07T05:09:03.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-12T09:05:12.000Z (about 2 years ago)
- Last Synced: 2025-02-24T12:06:08.260Z (4 months ago)
- Topics: dist-tag, github-action, npm-dist-tag, npm-publish, typescript
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/dist-tag
- Size: 1.6 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# dist-tag-action
[](https://github.com/flex-development/dist-tag-action/actions/workflows/action-test.yml)
[](https://conventionalcommits.org)
[](https://github.com/prettier/prettier)
[](https://github.com/voxpelli/badges-cjs-esm)
[](LICENSE.md)
[](https://typescriptlang.org)
> **[Distribution tag][3] lookup utility for GitHub Actions.**
## Usage
See [`action.yml`](action.yml)
```yaml
name: dist-tag
on:
workflow_dispatch:
inputs:
delimiter:
description: lookup target separator
required: true
target:
description: lookup target
required: true
jobs:
dist-tag:
runs-on: ubuntu-latest
steps:
- id: dist-tag
name: Get dist tag
uses: flex-development/dist-tag-action@
with:
delimiter: ${{ github.event.inputs.delimiter }}
target: ${{ github.event.inputs.target }}
- id: print-raw
name: Print raw dist tag
run: echo ${{ steps.dist-tag.outputs.tag }}
- id: print-flag
name: Print dist tag as npm flag (--tag )
run: echo ${{ steps.dist-tag.outputs.flag }}
- id: print-prerelease-state
name: Print prerelease state
run: echo ${{ steps.dist-tag.outputs.prerelease }}
```
## Inputs and Outputs
```yaml
inputs:
delimiter:
description: lookup target separator
required: false
target:
description: lookup target
required: false
outputs:
flag:
description: |
dist tag in cli flag format (--tag ) or empty string
see: https://docs.npmjs.com/cli/v8/commands/npm-publish#tag
prerelease:
description: boolean indicating prerelease state. determined by dist tag length
tag:
description: dist tag or empty string
```
## Examples
### Publish GitHub Release
See [`.github/workflows/release.yml`](.github/workflows/release.yml) for a
breadth worthy alternative.
```yaml
# Release
#
# Publish a GitHub release when a `release/*` branch is merged into `main`.
#
# References:
#
# - https://cli.github.com/manual/gh_release_create
# - https://docs.github.com/actions/using-workflows/events-that-trigger-workflows#pull_request
# - https://docs.github.com/actions/using-workflows/using-github-cli-in-workflows
# - https://github.com/actions/checkout
# - https://github.com/crazy-max/ghaction-import-gpg
---
name: release
on:
pull_request:
branches:
- main
types:
- closed
jobs:
metadata:
if: startsWith(github.head_ref, 'release/') && github.event.pull_request.merged
runs-on: ubuntu-latest
outputs:
prerelease: ${{ steps.dist-tag.outputs.prerelease }}
tag: ${{ steps.tag.outputs.result }}
version: ${{ steps.version.outputs.result }}
steps:
- id: checkout
name: Checkout ${{ github.head_ref }}
uses: actions/[email protected]
with:
ref: ${{ github.head_ref }}
- id: version
name: Get version
run: echo "::set-output name=result::$(jq .version package.json -r)"
- id: tag
name: Get release tag
run: echo "::set-output name=result::${{ steps.version.outputs.result }}"
- id: dist-tag
name: Get dist tag
uses: flex-development/dist-tag-action@
with:
target: ${{ steps.version.outputs.result }}
publish:
needs: metadata
runs-on: ubuntu-latest
environment:
name: production
url:
${{ format('{0}/{1}/releases/tag/{2}', github.server_url, github.repository,
needs.metadata.outputs.tag) }}
env:
NOTES_FILE: ./RELEASE_NOTES.md
TAG: ${{ needs.metadata.outputs.tag }}
steps:
- id: checkout
name: Checkout event.pull_request.merge_commit_sha
uses: actions/[email protected]
with:
fetch-depth: 0
ref: ${{ github.event.pull_request.merge_commit_sha }}
- id: gpg-import
name: Import GPG key
uses: crazy-max/[email protected]
with:
git_config_global: true
git_tag_gpgsign: true
git_user_signingkey: true
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
# todo: remove when https://github.com/crazy-max/ghaction-import-gpg/issues/118 is resolved
- id: gpg-trust
name: Set trust on GPG key
run: |
gpg --no-tty --command-fd 0 --edit-key ${{ steps.gpg-import.outputs.keyid }} << EOTRUST
trust
5
y
quit
EOTRUST
- id: yarn
name: Install dependencies
run: yarn
env:
HUSKY: 0
- id: pack
name: Pack project
run: yarn pack -o %s-%v.tgz
env:
NODE_ENV: production
- id: release-notes
name: Generate release notes
run: yarn conventional-changelog -o $NOTES_FILE
- id: tag
name: Create annotated tag
run: |
git tag --annotate --force --sign $TAG --message "release: $TAG"
git tag --verify $TAG
git push origin --tags
env:
GIT_AUTHOR_EMAIL: ${{ steps.gpg-import.outputs.email }}
GIT_AUTHOR_NAME: ${{ steps.gpg-import.outputs.name }}
GIT_COMMITTER_EMAIL: ${{ steps.gpg-import.outputs.email }}
GIT_COMMITTER_NAME: ${{ steps.gpg-import.outputs.name }}
- id: publish
name: Publish release
run: gh release create $TAG *.tgz -t=$TAG -F=$NOTES_FILE -p=$PRERELEASE
env:
GITHUB_TOKEN: ${{ secrets.PAT_REPO_ADMIN }}
PRERELEASE: ${{ needs.metadata.outputs.prerelease }}
```
## Built With
- [`@actions/core`][1]
- [`@flex-development/dist-tag`][2]
[1]: https://github.com/actions/toolkit/tree/main/packages/core
[2]: https://github.com/flex-development/dist-tag
[3]: https://docs.npmjs.com/cli/v8/commands/npm-dist-tag