https://github.com/managedkaos/keyword-releaser

Creates a release based on a keyword.
https://github.com/managedkaos/keyword-releaser

Last synced: 9 months ago
JSON representation

Creates a release based on a keyword.

• Host: GitHub
• URL: https://github.com/managedkaos/keyword-releaser
• Owner: managedkaos
• Created: 2019-04-06T15:38:43.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-12-30T17:20:29.000Z (over 1 year ago)
• Last Synced: 2025-09-11T08:45:53.302Z (10 months ago)
• Language: Shell
• Size: 14.6 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# GitHub Action to Create Releases Based on a Keyword

The Keyword Releaser will create a release based on the keyword specified in the arguments.

# Secrets

- `GITHUB_TOKEN` - _Required_ Allows the Action to authenticte with the GitHub API to create the release.

# Environment Variables

- N/A

# Arguments

- _Required_ - A single keyword.  If the keyword is found in a commit message, a release will be created.  Although case is ignored, it's suggested to use a unique, uppercase string like `FIXED`, `READY_TO_RELEASE`, or maybe even `PINEAPPLE`.

# Examples

Here's an example workflow that uses the Keyword Releaser action.  The workflow is triggered by a `PUSH` event and looks for the keyword `"FIXED"`.

```yaml

name: keyword-monitor

on:

  push:

jobs:

  keyword-releaser:

    runs-on: ubuntu-latest

    steps:

      - name: Keyword Releaser

        uses: managedkaos/keyword-releaser@master

        with:

          args: FIXED

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```