https://github.com/thesis/valkyrie-thread-action
https://github.com/thesis/valkyrie-thread-action
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thesis/valkyrie-thread-action
- Owner: thesis
- License: mit
- Created: 2023-12-21T19:46:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-24T02:25:27.000Z (about 2 years ago)
- Last Synced: 2025-12-26T12:51:47.676Z (6 months ago)
- Language: TypeScript
- Size: 134 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# valkyrie-thread-action
[](https://github.com/super-linter/super-linter)
[](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml)
[](./badges/coverage.svg)
This action can be triggered after a release tag is created to start a thread
with the release details.
## Usage
```yaml
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. :hammer_and_wrench: Install the dependencies
```bash
npm install
```
1. :building_construction: Package the TypeScript for distribution
```bash
npm run bundle
```
## Updating the action
1. Format, test, and build the action
```bash
npm run all
```
> [!WARNING]
>
> This step is important! It will run [`ncc`](https://github.com/vercel/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.
1. **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.
1. **Tagging the new release:** Once a valid new tag is entered, the script tags
the new release.
1. **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.