Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: Add release instructions #9

Merged
merged 2 commits into from
Nov 20, 2024
Merged

docs: Add release instructions #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6417cb0
docs: Add release instructions
ivov Nov 19, 2024
47f0cef
Phrasing
ivov Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ CLI utility to launch [n8n task runners](https://docs.n8n.io/PENDING).

- Install Node.js >=18.17
- Install n8n >= PENDING_VERSION
- Download launcher binary from [releases page](https://github.com/n8n-io/PENDING/releases)
- Download launcher binary from [releases page](https://github.com/n8n-io/task-runner-launcher/releases)

### Config

Expand Down Expand Up @@ -110,3 +110,17 @@ export N8N_RUNNERS_N8N_URI=...
export N8N_RUNNERS_AUTH_TOKEN=...
./bin/main javascript
```

## Release

1. Create a git tag following semver:

```sh
git tag 1.2.0
git push origin v1.2.0
```

2. Publish a [GitHub release](https://github.com/n8n-io/task-runner-launcher/releases/new) with the tag. The [`release` workflow](./.github/workflows/release.yml) will build binaries for arm64 and amd64 and upload them to the release in the [releases page](https://github.com/n8n-io/task-runner-launcher/releases).

> [!IMPORTANT]
> Mark the GitHub release as `latest` and NOT as `pre-release` or the `release` workflow will not run.