From b68c26e000860f144bb39d09afed7f831a8ae187 Mon Sep 17 00:00:00 2001 From: Mateus Abelli Date: Sat, 29 Apr 2023 20:55:20 -0300 Subject: [PATCH 1/3] Update README --- README.md | 117 +----------------------------------------------------- 1 file changed, 2 insertions(+), 115 deletions(-) diff --git a/README.md b/README.md index 7f0f2f3..5ea0963 100644 --- a/README.md +++ b/README.md @@ -1,116 +1,3 @@ -# Create a JavaScript Action +# PR Comment -

- javscript-action status -

- -Use this template to bootstrap the creation of a JavaScript action.:rocket: - -This template includes tests, linting, a validation workflow, publishing, and versioning guidance. - -If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) - -## Create an action from this template - -Click the `Use this Template` and provide the new repo details for your action - -## Code in Main - -Install the dependencies - -```bash -npm install -``` - -Run the tests :heavy_check_mark: - -```bash -$ npm test - - PASS ./index.test.js - ✓ throws invalid number (3ms) - ✓ wait 500 ms (504ms) - ✓ test runs (95ms) -... -``` - -## Change action.yml - -The action.yml defines the inputs and output for your action. - -Update the action.yml with your name, description, inputs and outputs for your action. - -See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions) - -## Change the Code - -Most toolkit and CI/CD operations involve async operations so the action is run in an async function. - -```javascript -const core = require('@actions/core'); -... - -async function run() { - try { - ... - } - catch (error) { - core.setFailed(error.message); - } -} - -run() -``` - -See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages. - -## Package for distribution - -GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules. - -Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder. - -Run prepare - -```bash -npm run prepare -``` - -Since the packaged index.js is run from the dist folder. - -```bash -git add dist -``` - -## Create a release branch - -Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions. - -Checkin to the v1 release branch - -```bash -git checkout -b v1 -git commit -a -m "v1 release" -``` - -```bash -git push origin v1 -``` - -Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project. - -Your action is now published! :rocket: - -See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) - -## Usage - -You can now consume the action by referencing the v1 branch - -```yaml -uses: actions/javascript-action@v1 -with: - milliseconds: 1000 -``` - -See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket: +Testing action \ No newline at end of file From 5562a325b1f83f4df0304decc8ea3564d1e7d71c Mon Sep 17 00:00:00 2001 From: Mateus Abelli Date: Sat, 29 Apr 2023 21:02:22 -0300 Subject: [PATCH 2/3] Update README --- README.md | 117 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 115 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5ea0963..7f0f2f3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,116 @@ -# PR Comment +# Create a JavaScript Action -Testing action \ No newline at end of file +

+ javscript-action status +

+ +Use this template to bootstrap the creation of a JavaScript action.:rocket: + +This template includes tests, linting, a validation workflow, publishing, and versioning guidance. + +If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) + +## Create an action from this template + +Click the `Use this Template` and provide the new repo details for your action + +## Code in Main + +Install the dependencies + +```bash +npm install +``` + +Run the tests :heavy_check_mark: + +```bash +$ npm test + + PASS ./index.test.js + ✓ throws invalid number (3ms) + ✓ wait 500 ms (504ms) + ✓ test runs (95ms) +... +``` + +## Change action.yml + +The action.yml defines the inputs and output for your action. + +Update the action.yml with your name, description, inputs and outputs for your action. + +See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions) + +## Change the Code + +Most toolkit and CI/CD operations involve async operations so the action is run in an async function. + +```javascript +const core = require('@actions/core'); +... + +async function run() { + try { + ... + } + catch (error) { + core.setFailed(error.message); + } +} + +run() +``` + +See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages. + +## Package for distribution + +GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules. + +Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder. + +Run prepare + +```bash +npm run prepare +``` + +Since the packaged index.js is run from the dist folder. + +```bash +git add dist +``` + +## Create a release branch + +Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions. + +Checkin to the v1 release branch + +```bash +git checkout -b v1 +git commit -a -m "v1 release" +``` + +```bash +git push origin v1 +``` + +Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project. + +Your action is now published! :rocket: + +See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) + +## Usage + +You can now consume the action by referencing the v1 branch + +```yaml +uses: actions/javascript-action@v1 +with: + milliseconds: 1000 +``` + +See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket: From 72e232f4870f6c4ba16f1f8c47bb2e07ada98796 Mon Sep 17 00:00:00 2001 From: Mateus Abelli Date: Sat, 29 Apr 2023 21:13:11 -0300 Subject: [PATCH 3/3] update --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7f0f2f3..75c84e7 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,10 @@ git commit -a -m "v1 release" git push origin v1 ``` + + + + Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project. Your action is now published! :rocket: