Initial commit

.github/codeql/codeql-config.yml

@@ -0,0 +1,5 @@
+name: JavaScript CodeQL Configuration
+
+paths-ignore:
+  - node_modules
+  - dist

.github/copilot-instructions.md

@@ -0,0 +1,127 @@
+# Copilot Instructions
+
+This GitHub Action is written in JavaScript and transpiled to a single file.
+Both the JavaScript sources and the **generated** JavaScript code are contained
+in this repository. The JavaScript sources are contained in the `src` directory
+and the code invoked by GitHub Actions is contained in the `dist` directory. A
+GitHub Actions workflow checks that the JavaScript code in `dist` is up-to-date.
+Therefore, you should not review any changes to the contents of the `dist`
+folder and it is expected that the JavaScript code in `dist` closely mirrors the
+code it is generated from.
+
+## Repository Structure
+
+| Path                 | Description                                              |
+| -------------------- | -------------------------------------------------------- |
+| `__fixtures__/`      | Unit Test Fixtures                                       |
+| `__tests__/`         | Unit Tests                                               |
+| `.devcontainer/`     | Development Container Configuration                      |
+| `.github/`           | GitHub Configuration                                     |
+| `.licenses/`         | License Information                                      |
+| `.vscode/`           | Visual Studio Code Configuration                         |
+| `badges/`            | Badges for readme                                        |
+| `dist/`              | Generated JavaScript Code                                |
+| `src/`               | JavaScript Source Code                                   |
+| `.env.example`       | Environment Variables Example for `@github/local-action` |
+| `.licensed.yml`      | Licensed Configuration                                   |
+| `.markdown-lint.yml` | Markdown Linter Configuration                            |
+| `.node-version`      | Node.js Version Configuration                            |
+| `.prettierrc.yml`    | Prettier Formatter Configuration                         |
+| `.yaml-lint.yml`     | YAML Linter Configuration                                |
+| `action.yml`         | GitHub Action Metadata                                   |
+| `CODEOWNERS`         | Code Owners File                                         |
+| `eslint.config.mjs`  | ESLint Configuration                                     |
+| `jest.config.js`     | Jest Configuration                                       |
+| `LICENSE`            | License File                                             |
+| `package.json`       | NPM Package Configuration                                |
+| `README.md`          | Project Documentation                                    |
+| `rollup.config.js`   | Rollup Bundler Configuration                             |
+
+## Environment Setup
+
+Install dependencies by running:
+
+```bash
+npm install
+```
+
+## Testing
+
+Ensure all unit tests pass by running:
+
+```bash
+npm run test
+```
+
+Unit tests should exist in the `__tests__` directory. They are powered by
+`jest`. Fixtures should be placed in the `__fixtures__` directory.
+
+## Bundling
+
+Any time files in the `src` directory are changed, you should run the following
+command to bundle the JavaScript code into the `dist` directory:
+
+```bash
+npm run bundle
+```
+
+## General Coding Guidelines
+
+- Follow standard JavaScript coding conventions and best practices
+- Changes should maintain consistency with existing patterns and style
+- Document changes clearly and thoroughly, including updates to existing
+  comments when appropriate
+- Do not include basic, unnecessary comments that simply restate what the code
+  is doing (focus on explaining _why_, not _what_)
+- Use consistent error handling patterns throughout the codebase
+- Keep functions focused and manageable
+- Use descriptive variable and function names that clearly convey their purpose
+- Use JSDoc comments to document functions, classes, and complex logic
+- After doing any refactoring, ensure to run `npm run test` to ensure that all
+  tests still pass and coverage requirements are met
+- When suggesting code changes, always opt for the most maintainable approach.
+  Try your best to keep the code clean and follow "Don't Repeat Yourself" (DRY)
+  principles
+- Avoid unnecessary complexity and always consider the long-term maintainability
+  of the code
+- When writing unit tests, try to consider edge cases as well as the main path
+  of success. This will help ensure that the code is robust and can handle
+  unexpected inputs or situations
+- Use the `@actions/core` package for logging over `console` to ensure
+  compatibility with GitHub Actions logging features
+
+### Versioning
+
+GitHub Actions are versioned using branch and tag names. Please ensure the
+version in the project's `package.json` is updated to reflect the changes made
+in the codebase. The version should follow
+[Semantic Versioning](https://semver.org/) principles.
+
+## Pull Request Guidelines
+
+When creating a pull request (PR), please ensure that:
+
+- Keep changes focused and minimal (avoid large changes, or consider breaking
+  them into separate, smaller PRs)
+- Formatting checks pass
+- Linting checks pass
+- Unit tests pass and coverage requirements are met
+- The action has been transpiled to JavaScript and the `dist` directory is
+  up-to-date with the latest changes in the `src` directory
+- If necessary, the `README.md` file is updated to reflect any changes in
+  functionality or usage
+
+The body of the PR should include:
+
+- A summary of the changes
+- A special note of any changes to dependencies
+- A link to any relevant issues or discussions
+- Any additional context that may be helpful for reviewers
+
+## Code Review Guidelines
+
+When performing a code review, please follow these guidelines:
+
+- If there are changes that modify the functionality/usage of the action,
+  validate that there are changes in the `README.md` file that document the new
+  or modified functionality

.github/dependabot.yml

@@ -0,0 +1,26 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      actions-minor:
+        update-types:
+          - minor
+          - patch
+
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      npm-development:
+        dependency-type: development
+        update-types:
+          - minor
+          - patch
+      npm-production:
+        dependency-type: production
+        update-types:
+          - patch

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

@@ -0,0 +1,40 @@
+---
+mode: agent
+tools: ['changes', 'codebase', 'github']
+description: Generate release notes for updates to the repository.
+---
+
+# Create Release Notes
+
+You are an expert technical writer tasked with creating release notes for
+updates to this repository. Your specific task is to generate release notes that
+are clear, concise, and useful for developers and users of the project.
+
+## Guidelines
+
+Ensure you adhere to the following guidelines when creating release notes:
+
+- Use a clear and consistent format for the release notes
+- Include a summary of the changes made in the release
+- Highlight any new features, improvements, or bugfixes
+- If applicable, include instructions for upgrading or migrating to the new
+  version
+- Use technical language that is appropriate for the audience, but avoid jargon
+  that may not be understood by all users
+- Ensure that the release notes are easy to read and navigate
+- Include relevant issue or PR numbers where applicable
+- Use proper Markdown formatting
+- Use code blocks for commands, configuration examples, or code changes
+- Use note and warning callouts for important information
+
+## Versioning
+
+GitHub Actions are versioned using branch and tag names. The version in the
+project's `package.json` should reflect the changes made in the codebase and
+follow [Semantic Versioning](https://semver.org/) principles. Depending on the
+nature of the changes, please make sure to adjust the release notes accordingly:
+
+- For **major** changes, include a detailed description of the breaking changes
+  and how users can adapt to them
+- For **minor** changes, highlight new features and improvements
+- For **patch** changes, focus on bugfixes and minor improvements

.github/prompts/unit-test.prompt.md

@@ -0,0 +1,90 @@
+---
+mode: agent
+tools: ['codebase', 'github']
+description: Generate unit tests for one or more files in the repository.
+---
+
+# Create Unit Test(s)
+
+You are an expert software engineer tasked with creating unit tests for the
+repository. Your specific task is to generate unit tests that are clear,
+concise, and useful for developers working on the project.
+
+## Guidelines
+
+Ensure you adhere to the following guidelines when creating unit tests:
+
+- Use a clear and consistent format for the unit tests
+- Include a summary of the functionality being tested
+- Use descriptive test names that clearly convey their purpose
+- Ensure tests cover both the main path of success and edge cases
+- Use proper assertions to validate the expected outcomes
+- Use `jest` for writing and running tests
+- Place unit tests in the `__tests__` directory
+- Use fixtures for any necessary test data, placed in the `__fixtures__`
+  directory
+
+## Example
+
+Use the following as an example of how to structure your unit tests:
+
+```javascript
+/**
+ * Unit tests for the action's main functionality, src/main.js
+ */
+import { jest } from '@jest/globals'
+import * as core from '../__fixtures__/core.js'
+import { wait } from '../__fixtures__/wait.js'
+
+// Mocks should be declared before the module being tested is imported.
+jest.unstable_mockModule('@actions/core', () => core)
+jest.unstable_mockModule('../src/wait.js', () => ({ wait }))
+
+// The module being tested should be imported dynamically. This ensures that the
+// mocks are used in place of any actual dependencies.
+const { run } = await import('../src/main.js')
+
+describe('main.js', () => {
+  beforeEach(() => {
+    // Set the action's inputs as return values from core.getInput().
+    core.getInput.mockImplementation(() => '500')
+
+    // Mock the wait function so that it does not actually wait.
+    wait.mockImplementation(() => Promise.resolve('done!'))
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks()
+  })
+
+  it('Sets the time output', async () => {
+    await run()
+
+    // Verify the time output was set.
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      1,
+      'time',
+      // Simple regex to match a time string in the format HH:MM:SS.
+      expect.stringMatching(/^\d{2}:\d{2}:\d{2}/)
+    )
+  })
+
+  it('Sets a failed status', async () => {
+    // Clear the getInput mock and return an invalid value.
+    core.getInput.mockClear().mockReturnValueOnce('this is not a number')
+
+    // Clear the wait mock and return a rejected promise.
+    wait
+      .mockClear()
+      .mockRejectedValueOnce(new Error('milliseconds is not a number'))
+
+    await run()
+
+    // Verify that the action was marked as failed.
+    expect(core.setFailed).toHaveBeenNthCalledWith(
+      1,
+      'milliseconds is not a number'
+    )
+  })
+})
+```

.github/workflows/check-dist.yml

@@ -0,0 +1,76 @@
+# In JavaScript actions, `dist/` is a special directory. When you reference
+# an action with the `uses:` property, `dist/index.js` is the code that will be
+# run. For this project, the `dist/index.js` file is transpiled from other
+# source files. This workflow ensures the `dist/` directory contains the
+# expected transpiled code.
+#
+# If this workflow is run from a feature branch, it will act as an additional CI
+# check and fail if the checked-in `dist/` directory does not match what is
+# expected from the build.
+name: Check Transpiled JavaScript
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  check-dist:
+    name: Check dist/
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        id: setup-node
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: .node-version
+          cache: npm
+
+      - name: Remove dist/ Directory
+        id: remove-dist
+        run: npx rimraf ./dist
+
+      - name: Install Dependencies
+        id: install
+        run: npm ci
+
+      - name: Build dist/ Directory
+        id: build
+        run: npm run bundle
+
+      # This will fail the workflow if the `dist/` directory is different than
+      # expected.
+      - name: Compare Directories
+        id: diff
+        run: |
+          if [ ! -d dist/ ]; then
+            echo "Expected dist/ directory does not exist.  See status below:"
+            ls -la ./
+            exit 1
+          fi
+          if [ "$(git diff --ignore-space-at-eol --text dist/ | wc -l)" -gt "0" ]; then
+            echo "Detected uncommitted changes after build. See status below:"
+            git diff --ignore-space-at-eol --text dist/
+            exit 1
+          fi
+
+      # If `dist/` was different than expected, upload the expected version as a
+      # workflow artifact.
+      - if: ${{ failure() && steps.diff.outcome == 'failure' }}
+        name: Upload Artifact
+        id: upload
+        uses: actions/upload-artifact@v5
+        with:
+          name: dist
+          path: dist/

.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+name: Continuous Integration
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test-javascript:
+    name: JavaScript Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        id: setup-node
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: .node-version
+          cache: npm
+
+      - name: Install Dependencies
+        id: npm-ci
+        run: npm ci
+
+      - name: Check Format
+        id: npm-format-check
+        run: npm run format:check
+
+      - name: Lint
+        id: npm-lint
+        run: npm run lint
+
+      - name: Test
+        id: npm-ci-test
+        run: npm run ci-test
+
+  test-action:
+    name: GitHub Actions Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v6
+
+      - name: Test Local Action
+        id: test-action
+        uses: ./
+        with:
+          milliseconds: 2000
+
+      - name: Print Output
+        id: output
+        run: echo "${{ steps.test-action.outputs.time }}"

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,49 @@
+name: CodeQL
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+  schedule:
+    - cron: '31 7 * * 3'
+
+permissions:
+  actions: read
+  checks: write
+  contents: read
+  security-events: write
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language:
+          - javascript
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v6
+
+      - name: Initialize CodeQL
+        id: initialize
+        uses: github/codeql-action/init@v4
+        with:
+          config-file: .github/codeql/codeql-config.yml
+          languages: ${{ matrix.language }}
+          source-root: src
+
+      - name: Autobuild
+        id: autobuild
+        uses: github/codeql-action/autobuild@v4
+
+      - name: Perform CodeQL Analysis
+        id: analyze
+        uses: github/codeql-action/analyze@v4

.github/workflows/licensed.yml

@@ -0,0 +1,74 @@
+# This workflow checks the statuses of cached dependencies used in this action
+# with the help of the Licensed tool. If any licenses are invalid or missing,
+# this workflow will fail. See: https://github.com/licensee/licensed
+
+name: Licensed
+
+on:
+  # Uncomment the below lines to run this workflow on pull requests and pushes
+  # to the default branch. This is useful for checking licenses before merging
+  # changes into the default branch.
+  # pull_request:
+  #   branches:
+  #     - main
+  # push:
+  #   branches:
+  #     - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  licensed:
+    name: Check Licenses
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        id: setup-node
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: .node-version
+          cache: npm
+
+      - name: Install Dependencies
+        id: npm-ci
+        run: npm ci
+
+      - name: Setup Ruby
+        id: setup-ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+
+      - uses: licensee/setup-licensed@v1.3.2
+        with:
+          version: 4.x
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      # If this is a workflow_dispatch event, update the cached licenses.
+      - if: ${{ github.event_name == 'workflow_dispatch' }}
+        name: Update Licenses
+        id: update-licenses
+        run: licensed cache
+
+      # Then, commit the updated licenses to the repository.
+      - if: ${{ github.event_name == 'workflow_dispatch' }}
+        name: Commit Licenses
+        id: commit-licenses
+        run: |
+          git config --local user.email "licensed-ci@users.noreply.github.com"
+          git config --local user.name "licensed-ci"
+          git add .
+          git commit -m "Auto-update license files"
+          git push
+
+      # Last, check the status of the cached licenses.
+      - name: Check Licenses
+        id: check-licenses
+        run: licensed status

.github/workflows/linter.yml

@@ -0,0 +1,60 @@
+# This workflow will lint the entire codebase using the
+# `super-linter/super-linter` action.
+#
+# For more information, see the super-linter repository:
+#     https://github.com/super-linter/super-linter
+name: Lint Codebase
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  packages: read
+  statuses: write
+
+jobs:
+  lint:
+    name: Lint Codebase
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        id: setup-node
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: .node-version
+          cache: npm
+
+      - name: Install Dependencies
+        id: install
+        run: npm ci
+
+      - name: Lint Codebase
+        id: super-linter
+        uses: super-linter/super-linter/slim@v8
+        env:
+          CHECKOV_FILE_NAME: .checkov.yml
+          DEFAULT_BRANCH: main
+          FILTER_REGEX_EXCLUDE: dist/**/*
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          LINTER_RULES_PATH: .
+          VALIDATE_ALL_CODEBASE: true
+          VALIDATE_BIOME_FORMAT: false
+          VALIDATE_BIOME_LINT: false
+          VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
+          VALIDATE_JAVASCRIPT_ES: false
+          VALIDATE_JSCPD: false
+          VALIDATE_TYPESCRIPT_ES: false
+          VALIDATE_JSON: false