Skip to content

Commit

Permalink
ARCH-1916 - Refactor Tweaks
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
danielle-casella-adams committed Sep 6, 2023
1 parent 67a5334 commit 896c683
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-and-review-pr.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/increment-version-on-merge.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
node_modules/
node_modules/
/.vscode/launch.json
38 changes: 20 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <!-- omit in toc -->

- [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 <!-- omit in toc -->

- README.md
- [ ] Update the Inputs section with the correct action inputs
Expand Down Expand Up @@ -142,12 +143,13 @@ This project has adopted the [im-open's Code of Conduct](https://github.com/im-o

Copyright &copy; 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
<!-- Links -->
[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

0 comments on commit 896c683

Please sign in to comment.