Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/go-semantic-release/action

:octocat: semantic-release GitHub Action
https://github.com/go-semantic-release/action

Last synced: 11 days ago
JSON representation

:octocat: semantic-release GitHub Action

Host: GitHub
URL: https://github.com/go-semantic-release/action
Owner: go-semantic-release
License: mit
Created: 2020-04-07T08:02:18.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-02-18T16:28:00.000Z (9 months ago)
Last Synced: 2024-10-26T10:44:48.256Z (18 days ago)
Language: TypeScript
Homepage:
Size: 573 KB
Stars: 36
Watchers: 2
Forks: 14
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# go-semantic-release/action

The official go-semantic-release GitHub Action.

> :warning: This action always installs the [latest release](https://github.com/go-semantic-release/semantic-release/releases/latest) of go-semantic-release. Thus, the version of this repository is not linked to the used go-semantic-release version.

## Usage

To integrate [go-semantic-release](https://github.com/go-semantic-release/semantic-release) with your GitHub Actions pipeline, specify the name of this repository with a version tag as a step within your workflow config file:

```yaml
# If a 403 error occurs, make sure to set content permission to write
# see: https://github.com/go-semantic-release/action/issues/27
#permissions:
# contents: write

steps:
- uses: actions/checkout@master
- uses: go-semantic-release/action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```

## Arguments

| Input | Description | Usage |
|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| `github-token` | Used to create releases | Required |
| `changelog-file` | Create a changelog file (e.g CHANGELOG.md) | Optional |
| `ghr` | Create a .ghr file with the parameters for [tcnksm/ghr](https://github.com/tcnksm/ghr) | Optional |
| `update-file` | Update the version of a certain file | Optional |
| `dry` | Do not create a release | Optional |
| `prerelease` | Flags the release as a prerelease | Optional |
| `allow-initial-development-versions` | semantic-release will start your initial development release at 0.1.0 and will handle breaking changes as minor version updates. This option will be ignored if a release with major version greater than or equal 1 exists. | Optional |
| `force-bump-patch-version` | Increments the patch version if no changes are found | Optional |
| `changelog-generator-opt` | Options that are passed to the changelog-generator plugin. Seperated by "," | Optional |
| `prepend` | Flag changes to be prepended into the changelog file | Optional |
| `hooks` | Enable different hooks plugins. Seperated by "," | Optional |

## Example `ci.yml` for a npm package

```yaml
name: CI
on:
push:
branches:
- '**'
pull_request:
branches:
- '**'

# If a 403 error occurs, make sure to set content permission to write
# see: https://github.com/go-semantic-release/action/issues/27
#permissions:
# contents: write

jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: true
matrix:
node: [10, 12]
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node }}
- run: npm ci
- run: npm test
release:
runs-on: ubuntu-latest
needs: build
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 12
registry-url: 'https://registry.npmjs.org'
- uses: go-semantic-release/action@v1
id: semrel
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
update-file: package.json
changelog-generator-opt: "emojis=true"
- run: npm publish
if: steps.semrel.outputs.version != ''
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
```

## License

The [MIT License (MIT)](http://opensource.org/licenses/MIT)