From 896c68372b508037b23d54ee31df348d07a4b628 Mon Sep 17 00:00:00 2001 From: Danielle Adams Date: Wed, 6 Sep 2023 12:49:39 -0600 Subject: [PATCH] ARCH-1916 - Refactor Tweaks - Fix run-name of workflows - Add some comments to README.md so Index/TODO are not included in ToC - Re-organize links at bottom of README.md - Update .gitignore to exclude .vscode/launch.json --- .github/workflows/build-and-review-pr.yml | 2 +- .../workflows/increment-version-on-merge.yml | 6 ++- .gitignore | 3 +- README.md | 38 ++++++++++--------- 4 files changed, 27 insertions(+), 22 deletions(-) diff --git a/.github/workflows/build-and-review-pr.yml b/.github/workflows/build-and-review-pr.yml index 7e3e5df..f1274eb 100644 --- a/.github/workflows/build-and-review-pr.yml +++ b/.github/workflows/build-and-review-pr.yml @@ -1,5 +1,5 @@ name: Build and Review PR -run-name: Build and Review PR #${{ github.event.pull_request.number }} +run-name: 'Build and Review PR #${{ github.event.pull_request.number }}' on: # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token diff --git a/.github/workflows/increment-version-on-merge.yml b/.github/workflows/increment-version-on-merge.yml index aa943bf..aa5b41c 100644 --- a/.github/workflows/increment-version-on-merge.yml +++ b/.github/workflows/increment-version-on-merge.yml @@ -1,4 +1,6 @@ name: Increment Version on Merge +run-name: 'Increment Version for PR #${{ github.event.pull_request.number }}' + on: # https://securitylab.github.com/research/github-actions-preventing-pwn-requests/ # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token @@ -37,10 +39,10 @@ jobs: # The files that contain source code for the action. Only files that affect the action's execution # should be included like action.yml or package.json. Do not include files like README.md or .gitignore. # Files do not need to be explicitly provided here if they fall under one of the dirs in dirs-with-code. - # ** This value must match the same files-with-code argument specified in increment-version-on-merge.yml. + # ** This value must match the same files-with-code argument specified in build-and-review-pr.yml. files-with-code: 'action.yml,package.json,package-lock.json' # TODO: Update if there are additional files or scripts. # The directories that contain source code for the action. Only dirs with files that affect the action's # execution should be included like src or dist. Do not include dirs like .github or node_modules. - # ** This value must match the same dirs-with-code argument specified in increment-version-on-merge.yml. + # ** This value must match the same dirs-with-code argument specified in build-and-review-pr.yml. dirs-with-code: 'src,dist' # TODO: Update if there are additional directories with code for the action. diff --git a/.gitignore b/.gitignore index 40b878d..b6f7100 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -node_modules/ \ No newline at end of file +node_modules/ +/.vscode/launch.json \ No newline at end of file diff --git a/README.md b/README.md index 4d007d7..5f49710 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,21 @@ This template can be used to quickly start a new custom js action repository. Click the `Use this template` button at the top to get started. -## Index - -- [Inputs](#inputs) -- [Outputs](#outputs) -- [Usage Examples](#usage-examples) -- [Contributing](#contributing) - - [Incrementing the Version](#incrementing-the-version) - - [Source Code Changes](#source-code-changes) - - [Recompiling Manually](#recompiling-manually) - - [Updating the README.md](#updating-the-readmemd) -- [Code of Conduct](#code-of-conduct) -- [License](#license) - -## TODOs +## Index + +- [javascript-action-template](#javascript-action-template) + - [Inputs](#inputs) + - [Outputs](#outputs) + - [Usage Examples](#usage-examples) + - [Contributing](#contributing) + - [Incrementing the Version](#incrementing-the-version) + - [Source Code Changes](#source-code-changes) + - [Recompiling Manually](#recompiling-manually) + - [Updating the README.md](#updating-the-readmemd) + - [Code of Conduct](#code-of-conduct) + - [License](#license) + +## TODOs - README.md - [ ] Update the Inputs section with the correct action inputs @@ -142,12 +143,13 @@ This project has adopted the [im-open's Code of Conduct](https://github.com/im-o Copyright © 2023, Extend Health, LLC. Code released under the [MIT license](LICENSE). -[git-version-lite]: https://github.com/im-open/git-version-lite -[esbuild]: https://esbuild.github.io/getting-started/#bundling-for-node + [Incrementing the Version]: #incrementing-the-version [Recompiling Manually]: #recompiling-manually +[source code]: #source-code-changes [Updating the README.md]: #updating-the-readmemd +[usage examples]: #usage-examples [build-and-review-pr]: ./.github/workflows/build-and-review-pr.yml [increment-version-on-merge]: ./.github/workflows/increment-version-on-merge.yml -[source code]: #source-code-changes -[usage examples]: #usage-examples +[esbuild]: https://esbuild.github.io/getting-started/#bundling-for-node +[git-version-lite]: https://github.com/im-open/git-version-lite