https://github.com/raulanatol/github-actions-releaser

Github action to semantic release versions
https://github.com/raulanatol/github-actions-releaser

Last synced: 18 days ago
JSON representation

Github action to semantic release versions

• Host: GitHub
• URL: https://github.com/raulanatol/github-actions-releaser
• Owner: raulanatol
• License: mit
• Created: 2020-05-02T16:46:55.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-25T05:35:51.000Z (7 months ago)
• Last Synced: 2024-10-14T01:42:45.985Z (about 1 month ago)
• Language: TypeScript
• Size: 1.31 MB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    
Github Actions Releaser



This action generates release notes based on the closed issues.


# Inputs

| Key | Description | Required | Type |

| --- | ----------- | -------- | ---- |

| `GITHUB_TOKEN` | The github Token | **TRUE** | **SECRET** |

| `TAG_NAME` | The new tag name. Do not use it if you want to auto tagging | **FALSE** | String |

# Example usage

Create the file `workflow.yml` in `.github/workflows` folder.

```yaml

name: Release

on:

  push:

    tags:

      - 'v*'

jobs:

  deploy:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - name: Generate release notes

        uses: raulanatol/github-actions-releaser@main

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

## With custom tag name

```yaml

name: Release

on:

  push:

    tags:

      - 'v*'

jobs:

  deploy:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - name: Generate release notes

        uses: raulanatol/github-actions-releaser@main

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

          TAG_NAME: vTestName

```

# Example projects

- [Javascript] https://github.com/raulanatol/javascript-example-gar