Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mikogs committed Oct 30, 2023
1 parent 881e861 commit 9c971ec
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# github-actions

## Creating javascript actions
Please follow the official GitHub docs [here](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action#commit-tag-and-push-your-action-to-github)
and use `@vercel/ncc` to compile the action into one `dist/index.js` file. Do not commmit `node_modules` directory as it contains loads of files.

### TL;DR

* install vercel with `npm install -g @vercel/ncc`
* create `src/index.js` and `action.yml` files
* run `npm install`
* run `ncc build src/index.js`
* commit `src/index.js`, `dist/index.js` and `action.yml`

0 comments on commit 9c971ec

Please sign in to comment.