Skip to content

Latest commit

 

History

History
80 lines (62 loc) · 2.72 KB

README.md

File metadata and controls

80 lines (62 loc) · 2.72 KB
Raw

valkyrie-thread-action

GitHub Super-Linter CI Check dist/ Coverage

This action can be triggered after a release tag is created to start a thread with the release details.

Usage

on:
  push:
    tags:
      - v1.*

steps:
  - name: Example action
    id: example-action
    uses: thesis/valyrie-thread-action@v1
    with:
      threadName: 'v1.0'
      channelName: 'release'
      message: 'release notes'
      webhookUrl: ${{ secrets.WEBHOOK_URL }}
      webhookAuth: ${{ secrets.WEBHOOK_AUTH }}

Initial Local Setup

  1. 🛠️ Install the dependencies

    npm install

  2. 🏗️ Package the TypeScript for distribution

    npm run bundle

Updating the action

  1. Format, test, and build the action

    npm run all

    [!WARNING]

    This step is important! It will run ncc to build the final JavaScript action code with all dependencies included. If you do not run this step, your action will not work correctly when it is used in a workflow. This step also includes the --license option for ncc, which will create a license file for all of the production node modules used in your project.

Publishing a new release

This project includes a helper script designed to streamline the process of tagging and pushing new releases for GitHub Actions.

GitHub Actions allows users to select a specific version of the action to use, based on release tags. Our script simplifies this process by performing the following steps:

  1. Retrieving the latest release tag: The script starts by fetching the most recent release tag by looking at the local data available in your repository.
  2. Prompting for a new release tag: The user is then prompted to enter a new release tag. To assist with this, the script displays the latest release tag and provides a regular expression to validate the format of the new tag.
  3. Tagging the new release: Once a valid new tag is entered, the script tags the new release.
  4. Pushing the new tag to the remote: Finally, the script pushes the new tag to the remote repository. From here, you will need to create a new release in GitHub and users can easily reference the new tag in their workflows.