https://github.com/labd/changie-release-action

GitHub action for Changie
https://github.com/labd/changie-release-action

changie github-actions

Last synced: 12 months ago
JSON representation

GitHub action for Changie

• Host: GitHub
• URL: https://github.com/labd/changie-release-action
• Owner: labd
• License: mit
• Created: 2023-03-07T21:04:25.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-03-03T10:30:16.000Z (over 1 year ago)
• Last Synced: 2025-06-25T11:52:56.790Z (12 months ago)
• Topics: changie, github-actions
• Homepage:
• Size: 39.1 KB
• Stars: 4
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# changie-release-action

Automate version and release management using [changie](https://github.com/miniscruff/changie)

This action creates a new PR with an updated `CHANGELOG.md` file. When merged it

will automatically create a new tag and trigger another GitHub action workflow

that can then do the actual release.

The workflow is inspired both by [changie](https://github.com/miniscruff/changie)

and [@changesets/action](https://github.com/changesets/action)

## Usage

```yaml

name: Test changes

on:

  push:

    branches:

      - 'main'

permissions:

  contents: write

  pull-requests: write

  actions: write

jobs:

  release:

    runs-on: ubuntu-latest

    steps:

    - name: Checkout

      uses: actions/checkout@v3

      with:

        fetch-depth: 0

    - name: Prepare release

      uses: labd/changie-release-action@v0.6.0

      with:

        github-token: ${{ secrets.GITHUB_TOKEN }}

        # Optionally run a command with the new version number when the new

        # version is determined.

        version-command: 'echo "New version is $PACKAGE_VERSION" > version.txt'

        # Trigger another release workflow to do the actual release.

        # Set to for example `release.yaml` to trigger that workflow.

        # Default is no trigger

        release-workflow: 'release.yaml'

```

## Triggering a release

This triggered workflow needs the `on: workflows` event. For example:

```yaml

name: Release

on:

  workflow_dispatch:

jobs:

  release:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

      - name: Set env

        run: echo "${GITHUB_REF#refs/*/}"

```