Skip to content

Commit

Permalink
update node version from 16 -> 20 (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomily1 authored Feb 12, 2024
1 parent da22930 commit 081044f
Show file tree
Hide file tree
Showing 4 changed files with 838 additions and 807 deletions.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,35 @@ Release notes grouped by issue status (similar to JIRA release notes)

## NOTE:

This assumes all tickets belong to the same project. For example, you can not have an array of issue tickets from multiple projects. Release versions in JIRA are created per project basis.
This assumes all tickets belong to the same project. For example, you can not have an array of issue tickets from multiple projects. Release versions in JIRA are created per project basis.

## Compiling and pushing changes

Checking in your node_modules directory can cause problems. As an alternative, you can use a tool called @vercel/ncc to compile your code and modules into one file used for distribution.

Install vercel/ncc by running this command in your terminal.

`npm i -g @vercel/ncc`

Compile your index.js file.

`ncc build index.js --license licenses.txt`

You'll see a new dist/index.js file with your code and the compiled modules. You will also see an accompanying dist/licenses.txt file containing all the licenses of the node_modules you are using.

Change the main keyword in your action.yml file to use the new dist/index.js file.

`main: 'dist/index.js'`

If you already checked in your node_modules directory, remove it.

`rm -rf node_modules/*`

From your terminal, commit the updates to your action.yml, dist/index.js, and node_modules files.

```shell
git add action.yml dist/index.js node_modules/*
git commit -m "Use vercel/ncc"
git tag -a -m "My first action release" v1.1
git push --follow-tags
```
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ outputs:
notes:
description: 'Release notes (similar to JIRA release notes)'
runs:
using: 'node16'
using: 'node20'
main: 'dist/index.js'
Loading

0 comments on commit 081044f

Please sign in to comment.