Skip to content

Commit c76baa6

Browse files
ltshbltshb
committed
PB-2263: Updated to node24
The easiest way was to take all the boiler plates files from the template repo https://github.com/actions/typescript-action/ and adapt it from there.
1 parent 4118058 commit c76baa6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+93310
-21975
lines changed

‎.checkov.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# See: https://www.checkov.io/1.Welcome/Quick%20Start.html
2+
3+
compact: true
4+
quiet: true
5+
skip-path:
6+
- coverage
7+
- node_modules

‎.env.example‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# dotenv-linter:off IncorrectDelimiter
2+
3+
# Do not commit your actual .env file to Git! This may contain secrets or other
4+
# private information.
5+
6+
# Enable/disable step debug logging (default: `false`). For local debugging, it
7+
# may be useful to set it to `true`.
8+
ACTIONS_STEP_DEBUG=true
9+
10+
# GitHub Actions inputs should follow `INPUT_<name>` format (case-sensitive).
11+
# Hyphens should not be converted to underscores!
12+
INPUT_MILLISECONDS=2400
13+
14+
# GitHub Actions default environment variables. These are set for every run of a
15+
# workflow and can be used in your actions. Setting the value here will override
16+
# any value set by the local-action tool.
17+
# https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
18+
19+
# CI="true"
20+
# GITHUB_ACTION=""
21+
# GITHUB_ACTION_PATH=""
22+
# GITHUB_ACTION_REPOSITORY=""
23+
# GITHUB_ACTIONS=""
24+
# GITHUB_ACTOR=""
25+
# GITHUB_ACTOR_ID=""
26+
# GITHUB_API_URL=""
27+
# GITHUB_BASE_REF=""
28+
# GITHUB_ENV=""
29+
# GITHUB_EVENT_NAME=""
30+
# GITHUB_EVENT_PATH=""
31+
# GITHUB_GRAPHQL_URL=""
32+
# GITHUB_HEAD_REF=""
33+
# GITHUB_JOB=""
34+
# GITHUB_OUTPUT=""
35+
# GITHUB_PATH=""
36+
# GITHUB_REF=""
37+
# GITHUB_REF_NAME=""
38+
# GITHUB_REF_PROTECTED=""
39+
# GITHUB_REF_TYPE=""
40+
# GITHUB_REPOSITORY=""
41+
# GITHUB_REPOSITORY_ID=""
42+
# GITHUB_REPOSITORY_OWNER=""
43+
# GITHUB_REPOSITORY_OWNER_ID=""
44+
# GITHUB_RETENTION_DAYS=""
45+
# GITHUB_RUN_ATTEMPT=""
46+
# GITHUB_RUN_ID=""
47+
# GITHUB_RUN_NUMBER=""
48+
# GITHUB_SERVER_URL=""
49+
# GITHUB_SHA=""
50+
# GITHUB_STEP_SUMMARY=""
51+
# GITHUB_TRIGGERING_ACTOR=""
52+
# GITHUB_WORKFLOW=""
53+
# GITHUB_WORKFLOW_REF=""
54+
# GITHUB_WORKFLOW_SHA=""
55+
# GITHUB_WORKSPACE=""
56+
# RUNNER_ARCH=""
57+
# RUNNER_DEBUG=""
58+
# RUNNER_NAME=""
59+
# RUNNER_OS=""
60+
# RUNNER_TEMP=""
61+
# RUNNER_TOOL_CACHE=""

‎.eslintignore‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎.eslintrc.json‎

Lines changed: 0 additions & 55 deletions
This file was deleted.

‎.gitattributes‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
dist/** -diff linguist-generated=true
1+
* text=auto eol=lf
2+
3+
dist/** -diff linguist-generated=true

‎.github/codeql/codeql-config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name: JavaScript CodeQL Configuration
2+
3+
paths-ignore:
4+
- node_modules
5+
- dist

‎.github/copilot-instructions.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Copilot Instructions
2+
3+
This GitHub Action is written in TypeScript and transpiled to JavaScript. Both
4+
the TypeScript sources and the **generated** JavaScript code are contained in
5+
this repository. The TypeScript sources are contained in the `src` directory and
6+
the JavaScript code is contained in the `dist` directory. A GitHub Actions
7+
workflow checks that the JavaScript code in `dist` is up-to-date. Therefore, you
8+
should not review any changes to the contents of the `dist` folder and it is
9+
expected that the JavaScript code in `dist` closely mirrors the TypeScript code
10+
it is generated from.
11+
12+
## Repository Structure
13+
14+
| Path | Description |
15+
| -------------------- | -------------------------------------------------------- |
16+
| `__fixtures__/` | Unit Test Fixtures |
17+
| `__tests__/` | Unit Tests |
18+
| `.devcontainer/` | Development Container Configuration |
19+
| `.github/` | GitHub Configuration |
20+
| `.licenses/` | License Information |
21+
| `.vscode/` | Visual Studio Code Configuration |
22+
| `badges/` | Badges for readme |
23+
| `dist/` | Generated JavaScript Code |
24+
| `src/` | TypeScript Source Code |
25+
| `.env.example` | Environment Variables Example for `@github/local-action` |
26+
| `.licensed.yml` | Licensed Configuration |
27+
| `.markdown-lint.yml` | Markdown Linter Configuration |
28+
| `.node-version` | Node.js Version Configuration |
29+
| `.prettierrc.yml` | Prettier Formatter Configuration |
30+
| `.yaml-lint.yml` | YAML Linter Configuration |
31+
| `action.yml` | GitHub Action Metadata |
32+
| `CODEOWNERS` | Code Owners File |
33+
| `eslint.config.mjs` | ESLint Configuration |
34+
| `jest.config.js` | Jest Configuration |
35+
| `LICENSE` | License File |
36+
| `package.json` | NPM Package Configuration |
37+
| `README.md` | Project Documentation |
38+
| `rollup.config.ts` | Rollup Bundler Configuration |
39+
| `tsconfig.json` | TypeScript Configuration |
40+
41+
## Environment Setup
42+
43+
Install dependencies by running:
44+
45+
```bash
46+
npm install
47+
```
48+
49+
## Testing
50+
51+
Ensure all unit tests pass by running:
52+
53+
```bash
54+
npm run test
55+
```
56+
57+
Unit tests should exist in the `__tests__` directory. They are powered by
58+
`jest`. Fixtures should be placed in the `__fixtures__` directory.
59+
60+
## Bundling
61+
62+
Any time files in the `src` directory are changed, you should run the following
63+
command to bundle the TypeScript code into JavaScript:
64+
65+
```bash
66+
npm run bundle
67+
```
68+
69+
## General Coding Guidelines
70+
71+
- Follow standard TypeScript and JavaScript coding conventions and best
72+
practices
73+
- Changes should maintain consistency with existing patterns and style
74+
- Document changes clearly and thoroughly, including updates to existing
75+
comments when appropriate
76+
- Do not include basic, unnecessary comments that simply restate what the code
77+
is doing (focus on explaining _why_, not _what_)
78+
- Use consistent error handling patterns throughout the codebase
79+
- Use TypeScript's type system to ensure type safety and clarity
80+
- Keep functions focused and manageable
81+
- Use descriptive variable and function names that clearly convey their purpose
82+
- Use JSDoc comments to document functions, classes, and complex logic
83+
- After doing any refactoring, ensure to run `npm run test` to ensure that all
84+
tests still pass and coverage requirements are met
85+
- When suggesting code changes, always opt for the most maintainable approach.
86+
Try your best to keep the code clean and follow "Don't Repeat Yourself" (DRY)
87+
principles
88+
- Avoid unnecessary complexity and always consider the long-term maintainability
89+
of the code
90+
- When writing unit tests, try to consider edge cases as well as the main path
91+
of success. This will help ensure that the code is robust and can handle
92+
unexpected inputs or situations
93+
- Use the `@actions/core` package for logging over `console` to ensure
94+
compatibility with GitHub Actions logging features
95+
96+
### Versioning
97+
98+
GitHub Actions are versioned using branch and tag names. Please ensure the
99+
version in the project's `package.json` is updated to reflect the changes made
100+
in the codebase. The version should follow
101+
[Semantic Versioning](https://semver.org/) principles.
102+
103+
## Pull Request Guidelines
104+
105+
When creating a pull request (PR), please ensure that:
106+
107+
- Keep changes focused and minimal (avoid large changes, or consider breaking
108+
them into separate, smaller PRs)
109+
- Formatting checks pass
110+
- Linting checks pass
111+
- Unit tests pass and coverage requirements are met
112+
- The action has been transpiled to JavaScript and the `dist` directory is
113+
up-to-date with the latest changes in the `src` directory
114+
- If necessary, the `README.md` file is updated to reflect any changes in
115+
functionality or usage
116+
117+
The body of the PR should include:
118+
119+
- A summary of the changes
120+
- A special note of any changes to dependencies
121+
- A link to any relevant issues or discussions
122+
- Any additional context that may be helpful for reviewers
123+
124+
## Code Review Guidelines
125+
126+
When performing a code review, please follow these guidelines:
127+
128+
- If there are changes that modify the functionality/usage of the action,
129+
validate that there are changes in the `README.md` file that document the new
130+
or modified functionality

‎.github/dependabot.yml‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,24 @@ updates:
33
- package-ecosystem: github-actions
44
directory: /
55
schedule:
6-
interval: daily
6+
interval: monthly
7+
groups:
8+
actions-minor:
9+
update-types:
10+
- minor
11+
- patch
712

813
- package-ecosystem: npm
914
directory: /
1015
schedule:
11-
interval: daily
16+
interval: monthly
17+
groups:
18+
npm-development:
19+
dependency-type: development
20+
update-types:
21+
- minor
22+
- patch
23+
npm-production:
24+
dependency-type: production
25+
update-types:
26+
- patch

‎.github/prompts/create-release-notes.prompt.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Create Release Notes
2+
3+
You are an expert technical writer tasked with creating release notes for
4+
updates to this repository. Your specific task is to generate release notes that
5+
are clear, concise, and useful for developers and users of the project.
6+
7+
## Guidelines
8+
9+
Ensure you adhere to the following guidelines when creating release notes:
10+
11+
- Use a clear and consistent format for the release notes
12+
- Include a summary of the changes made in the release
13+
- Highlight any new features, improvements, or bugfixes
14+
- If applicable, include instructions for upgrading or migrating to the new
15+
version
16+
- Use technical language that is appropriate for the audience, but avoid jargon
17+
that may not be understood by all users
18+
- Ensure that the release notes are easy to read and navigate
19+
- Include relevant issue or PR numbers where applicable
20+
- Use proper Markdown formatting
21+
- Use code blocks for commands, configuration examples, or code changes
22+
- Use note and warning callouts for important information
23+
24+
## Versioning
25+
26+
GitHub Actions are versioned using branch and tag names. The version in the
27+
project's `package.json` should reflect the changes made in the codebase and
28+
follow [Semantic Versioning](https://semver.org/) principles. Depending on the
29+
nature of the changes, please make sure to adjust the release notes accordingly:
30+
31+
- For **major** changes, include a detailed description of the breaking changes
32+
and how users can adapt to them
33+
- For **minor** changes, highlight new features and improvements
34+
- For **patch** changes, focus on bugfixes and minor improvements

0 commit comments

Comments
 (0)