Skip to content

Note additional useage requirements #45

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
Relequestual wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Note additional useage requirements #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ jobs:

You can also use this action with other events - you'll just need to specify a `tag_name` (see below).

In order for the publish workflow to work correctly, you will need to modify the permissions for the GitHub token provided to workflows for the repository.
You can modify this setting in the repositories settings/actions/general, under "workflow permissions".
By default, only read permission is given, and this action needs write perissions.

## Example `package.json` for your project

The two important thing you'll need to set in your action are the `main` field and the `build` script. Here's an example of a minimal `package.json` that will use `@vercel/ncc` to compile your action to `dist/index.js`, update your `action.yml` file to use the `node16` runtime and point `build-and-tag-action` at the compiled file:
Expand Down