@ronaldphilipsen/local-action 0.0.0-stage → 7.1.0

package/.checkov.yml

@@ -0,0 +1,3 @@
+quiet: true
+skip-check:
+  - CKV2_GHA_1

package/.env.example

@@ -0,0 +1,379 @@
+################################################################################
+#    Do not commit your actual .env file to Git! This may contain secrets or   #
+#                         other sensitive information.                         #
+################################################################################
+
+################################################################################
+#                        @github/local-action Variables                        #
+################################################################################
+
+# Environment variables specific to the @github/local-action tool.
+
+######################################################################
+# The path to a workspace that can be used by `@github/local-action` #
+# during local testing. This will be used as the root directory for  #
+# any files created by your action, as well as any environment files #
+# that are created automatically by `@github/local-action`. If you   #
+# try to interact with the `@actions/artifact` or `@actions/cache`   #
+# packages, this tool will throw an error if this is not set to a    #
+# valid path.                                                        #
+######################################################################
+LOCAL_ACTION_WORKSPACE=""
+
+######################################################################
+# Local path where any artifacts will be saved. Will throw an error  #
+# if the action attempts to use the `@actions/artifact` package      #
+# without setting this value first.                                  #
+######################################################################
+LOCAL_ACTION_ARTIFACT_PATH=""
+
+######################################################################
+# Local path where any caches will be read or saved. Will throw an   #
+# error if the action attempts to use the `@actions/cache` package   #
+# without setting this value first.                                  #
+######################################################################
+LOCAL_ACTION_CACHE_PATH=""
+
+################################################################################
+#                            GitHub Actions Inputs                             #
+#                                                                              #
+# GitHub Actions inputs should follow `INPUT_<name>` format (all uppercase).   #
+# Hyphens should not be converted to underscores! If your `action.yml` file    #
+# contains default values for inputs, you do not need to set them here too.    #
+################################################################################
+
+INPUT_MILLISECONDS=2400
+
+################################################################################
+#                     GitHub Actions Environment Variables                     #
+################################################################################
+
+# The following variables are set for every run of a workflow and can be used in
+# your action. The initial values in this file are the defaults set by GitHub
+# Actions. You can override them to suit your needs.
+#
+# For more information, see:
+# https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
+
+######################################################################
+# Sets the maximum number of artifacts that will be returned in a    #
+# single list operation. Defaults to 1000.                           #
+######################################################################
+# ACTIONS_ARTIFACT_MAX_ARTIFACT_COUNT=1000
+
+######################################################################
+# Enable/disable step debug logging. Default is normally `false`,    #
+# but it is set to `true` for local debugging purposes.              #
+######################################################################
+ACTIONS_STEP_DEBUG=true
+
+######################################################################
+# Always set to `true`.                                              #
+######################################################################
+CI="true"
+
+######################################################################
+# The name of the action currently running, or the id of a step. For #
+# example, the second invocation of `actions/checkout` will be       #
+# `actionscheckout2`.                                                #
+######################################################################
+# GITHUB_ACTION=""
+
+######################################################################
+# Only supported in composite actions.                               #
+######################################################################
+# GITHUB_ACTION_PATH=""
+
+######################################################################
+# For a step executing an action, this is the owner and repository   #
+# name of the action. For example, `actions/checkout`.               #
+######################################################################
+# GITHUB_ACTION_REPOSITORY=""
+
+######################################################################
+# Always set to true when GitHub Actions is running the workflow.    #
+# You can use this variable to differentiate when tests are being    #
+# run locally or by GitHub Actions.                                  #
+######################################################################
+GITHUB_ACTIONS="true"
+
+######################################################################
+# The name of the person or app that initiated the workflow. For     #
+# example, `octocat`.                                                #
+######################################################################
+# GITHUB_ACTOR=""
+
+######################################################################
+# The account ID of the person or app that triggered the initial     #
+# workflow run. For example, `1234567`. Note that this is different  #
+# from the actor username.                                           #
+######################################################################
+# GITHUB_ACTOR_ID=""
+
+######################################################################
+# Returns the API URL. For example: `https://api.github.com`.        #
+######################################################################
+GITHUB_API_URL="https://api.github.com"
+
+######################################################################
+# The name of the base ref or target branch of the pull request in a #
+# workflow run. This is only set when the event that triggers a      #
+# workflow run is either pull_request or pull_request_target. For    #
+# example, `main`.                                                   #
+######################################################################
+# GITHUB_BASE_REF=""
+
+######################################################################
+# The name of the event that triggered the workflow. For example,    #
+# `workflow_dispatch`.                                               #
+######################################################################
+# GITHUB_EVENT_NAME=""
+
+######################################################################
+# The path to the file on the runner that contains the full event    #
+# webhook payload. For example, `/github/workflow/event.json`.       #
+######################################################################
+# GITHUB_EVENT_PATH=""
+
+######################################################################
+# Returns the GraphQL API URL. For example:                          #
+# `https://api.github.com/graphql`.                                  #
+######################################################################
+GITHUB_GRAPHQL_URL="https://api.github.com/graphql"
+
+######################################################################
+# The head ref or source branch of the pull request in a workflow    #
+# run. This property is only set when the event that triggers a      #
+# workflow run is either pull_request or pull_request_target. For    #
+# example, `feature-branch-1`.                                       #
+######################################################################
+# GITHUB_HEAD_REF=""
+
+######################################################################
+# The job_id of the current job. For example, `greeting_job`.        #
+######################################################################
+# GITHUB_JOB=""
+
+######################################################################
+# The fully-formed ref of the branch or tag that triggered the       #
+# workflow run. For workflows triggered by push, this is the branch  #
+# or tag ref that was pushed. For workflows triggered by             #
+# pull_request, this is the pull request merge branch. For workflows #
+# triggered by release, this is the release tag created. For other   #
+# triggers, this is the branch or tag ref that triggered the         #
+# workflow run. This is only set if a branch or tag is available for #
+# the event type. The ref given is fully-formed, meaning that for    #
+# branches the format is refs/heads/<branch_name>. For pull requests #
+# events except pull_request_target, it is                           #
+# refs/pull/<pr_number>/merge. pull_request_target events have the   #
+# ref from the base branch. For tags it is refs/tags/<tag_name>. For #
+# example, refs/heads/feature-branch-1.                              #
+######################################################################
+# GITHUB_REF=""
+
+######################################################################
+# The short ref name of the branch or tag that triggered the         #
+# workflow run. This value matches the branch or tag name shown on   #
+# GitHub. For example, `feature-branch-1`. For pull requests, the    #
+# format is `<pr_number>/merge`.                                     #
+######################################################################
+# GITHUB_REF_NAME=""
+
+######################################################################
+# `true` if branch protections or rulesets are configured for the    #
+# ref that triggered the workflow run.                               #
+######################################################################
+# GITHUB_REF_PROTECTED=""
+
+######################################################################
+# The type of ref that triggered the workflow run. Valid values are  #
+# `branch` or `tag`.                                                 #
+######################################################################
+# GITHUB_REF_TYPE=""
+
+######################################################################
+# The owner and repository name. For example, `octocat/Hello-World`. #
+######################################################################
+# GITHUB_REPOSITORY=""
+
+######################################################################
+# The ID of the repository. For example, `123456789`. Note that this #
+# is different from the repository name.                             #
+######################################################################
+# GITHUB_REPOSITORY_ID=""
+
+######################################################################
+# The repository owner's name. For example, `octocat`.               #
+######################################################################
+# GITHUB_REPOSITORY_OWNER=""
+
+######################################################################
+# The repository owner's account ID. For example, `1234567`. Note    #
+# that this is different from the owner's name.                      #
+######################################################################
+# GITHUB_REPOSITORY_OWNER_ID=""
+
+######################################################################
+# The number of days that workflow run logs and artifacts are kept.  #
+# For example, 90.                                                   #
+######################################################################
+GITHUB_RETENTION_DAYS="90"
+
+######################################################################
+# A unique number for each attempt of a particular workflow run in a #
+# repository. This number begins at `1` for the workflow run's first #
+# attempt, and increments with each re-run. For example, `3`.        #
+######################################################################
+GITHUB_RUN_ATTEMPT="1"
+
+######################################################################
+# A unique number for each workflow run within a repository. This    #
+# number does not change if you re-run the workflow run. For         #
+# example, `1658821493`.                                             #
+######################################################################
+# GITHUB_RUN_ID=""
+
+######################################################################
+# A unique number for each run of a particular workflow in a         #
+# repository. This number begins at `1` for the workflow's first     #
+# run, and increments with each new run. This number  does not       #
+# change if you re-run the workflow run. For example, `3`.           #
+######################################################################
+GITHUB_RUN_NUMBER="1"
+
+######################################################################
+# The URL of the GitHub server. For example: `https://github.com`.   #
+######################################################################
+GITHUB_SERVER_URL="https://github.com"
+
+######################################################################
+# The commit SHA that triggered the workflow. The value of this      #
+# commit SHA depends on the event that triggered the workflow. For   #
+# more information, see Events that trigger workflows. For example,  #
+# `ffac537e6cbbf934b08745a378932722df287a53`.                        #
+######################################################################
+# GITHUB_SHA=""
+
+######################################################################
+# The username of the user that initiated the workflow run. If the   #
+# workflow run is a re-run, this value may differ from               #
+# `github.actor`. Any workflow re-runs will use the privileges of    #
+# `github.actor`, even if the actor initiating the re-run            #
+# (`github.triggering_actor`) has different privileges.              #
+######################################################################
+# GITHUB_TRIGGERING_ACTOR=""
+
+######################################################################
+# The name of the workflow. For example, `My test workflow``. If the #
+# workflow file doesn't specify a name, the value of this variable   #
+# is the full path of the workflow file in the repository.           #
+######################################################################
+GITHUB_WORKFLOW="Local Action"
+
+######################################################################
+# The ref path to the workflow.                                      #
+######################################################################
+# GITHUB_WORKFLOW_REF=""
+
+######################################################################
+# The commit SHA for the workflow file.                              #
+######################################################################
+# GITHUB_WORKFLOW_SHA=""
+
+######################################################################
+# The default working directory on the runner for steps, and the     #
+# default location of your repository when using the checkout        #
+# action. For example, `/home/runner/work/my-repo-name/repo-name`.   #
+######################################################################
+# GITHUB_WORKSPACE=""
+
+######################################################################
+# The architecture of the runner executing the job. Possible values  #
+# are `X86`, X6`4, `ARM`, or `ARM64`.                                #
+######################################################################
+# RUNNER_ARCH=""
+
+######################################################################
+# This is set only if debug logging is enabled, and always has the   #
+# value of 1. It can be useful as an indicator to enable additional  #
+# debugging or verbose logging in your own job steps. Default is     #
+# normally not set, but it is set to `1` for local debugging         #
+# purposes.                                                          #
+######################################################################
+RUNNER_DEBUG="1"
+
+######################################################################
+# The environment of the runner executing the job. Possible values   #
+# are: github-hosted for GitHub-hosted runners provided by GitHub,   #
+# and self-hosted for self-hosted runners configured by the          #
+# repository owner.                                                  #
+######################################################################
+RUNNER_ENVIRONMENT="github-hosted"
+
+######################################################################
+# The name of the runner executing the job. This name may not be     #
+# unique in a workflow run as runners at the repository and          #
+# organization levels could use the same name. For example,          #
+# `Hosted Agent`.                                                    #
+######################################################################
+RUNNER_NAME="Local Action"
+
+######################################################################
+# The operating system of the runner executing the job. Possible     #
+# values are `Linux`, `Windows`, or `macOS`. For example, `Windows`. #
+######################################################################
+# RUNNER_OS=""
+
+######################################################################
+# The path to a temporary directory on the runner. This directory is #
+# emptied at the beginning and end of each job. Note that files will #
+# not be removed if the runner's user account does not have          #
+# permission to delete them. For example, `D:\a\_temp`.              #
+######################################################################
+# RUNNER_TEMP=""
+
+######################################################################
+# The path to the directory containing preinstalled tools for        #
+# GitHub-hosted runners. For more information, see Using             #
+# GitHub-hosted runners. For example, `C:\hostedtoolcache\windows`.  #
+######################################################################
+# RUNNER_TOOL_CACHE=""
+
+
+################################################################################
+#                       GitHub Actions Environment Files                       #
+#                                                                              #
+# The following variables point to specific files on the runner that are used  #
+# to set environment variables, outputs, and other information. These files    #
+# are created and managed by GitHub Actions.                                   #
+#                                                                              #
+# Currently these are not used by `@github/local-action`.                      #
+################################################################################
+
+######################################################################
+# The path on the runner to the file that sets variables from        #
+# workflow commands. The path to this file is unique to the current  #
+# step and changes for each step in a job.                           #
+######################################################################
+# GITHUB_ENV=""
+
+######################################################################
+# The path on the runner to the file that sets the current step's    #
+# outputs from workflow commands. The path to this file is unique to #
+# the current step and changes for each step in a job.               #
+######################################################################
+# GITHUB_OUTPUT=""
+
+######################################################################
+# The path on the runner to the file that sets system `PATH`         #
+# variables from workflow commands. The path to this file is unique  #
+# to the current step and changes for each step in a job.            #
+######################################################################
+# GITHUB_PATH=""
+
+######################################################################
+# The path on the runner to the file that contains job summaries     #
+# from workflow commands. The path to this file is unique to the     #
+# current step and changes for each step in a job.                   #
+######################################################################
+# GITHUB_STEP_SUMMARY=""

package/.github/codeql/codeql-config.yml

@@ -0,0 +1,7 @@
+name: JavaScript CodeQL Configuration
+
+paths-ignore:
+  - coverage
+  - megalinter-reports
+  - node_modules
+  - reports

package/.github/copilot-instructions.md

@@ -0,0 +1,79 @@
+# Copilot Instructions
+
+## 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.
+
+## General Coding Guidelines
+
+- Follow standard TypeScript and 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
+- Use TypeScript's type system to ensure type safety and clarity
+- 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
+
+### 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
+- 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

package/.github/dependabot.yml

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

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,53 @@
+name: CodeQL
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    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:
+          - TypeScript
+
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}-${{ matrix.language }}
+      cancel-in-progress: true
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v6
+
+      - name: Initialize CodeQL
+        id: initialize
+        uses: github/codeql-action/init@v4
+        with:
+          languages: ${{ matrix.language }}
+          source-root: src
+          config-file: .github/codeql/codeql-config.yml
+
+      - name: Autobuild
+        id: autobuild
+        uses: github/codeql-action/autobuild@v4
+
+      - name: Perform CodeQL Analysis
+        id: analyze
+        uses: github/codeql-action/analyze@v4

package/.github/workflows/continuous-delivery.yml

@@ -0,0 +1,93 @@
+name: Continuous Delivery
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+    paths:
+      - bin/**/*
+      - src/**/*
+      - .node-version
+      - package-lock.json
+      - package.json
+      - tsconfig.base.json
+      - tsconfig.eslint.json
+      - tsconfig.json
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  publish:
+    name: Publish to npm
+    runs-on: ubuntu-latest
+
+    # Only run this job if one of the following is true:
+    # - It was run manually.
+    # - A PR was merged that was not from Dependabot or a fork.
+    if: |
+      github.event_name == 'workflow_dispatch' ||
+      (
+        github.event.pull_request.merged == true &&
+        startsWith(github.head_ref, 'dependabot/') == false &&
+        github.event.pull_request.head.repo.fork == false
+      )
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-tags: true
+
+      - name: Setup Node.js
+        id: setup-node
+        uses: actions/setup-node@v6
+        with:
+          cache: npm
+          node-version-file: .node-version
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install Dependencies
+        id: install
+        run: npm ci
+
+      - name: Test
+        id: test
+        run: npm run ci-test
+
+      - name: Publish
+        id: publish
+        run: |
+          npm publish --ignore-scripts --access public
+
+  release:
+    name: Create Release
+    runs-on: ubuntu-latest
+
+    needs: publish
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-tags: true
+
+      - name: Tag
+        id: tag
+        uses: issue-ops/semver@v3
+        with:
+          manifest-path: package.json
+          workspace: ${{ github.workspace }}
+          ref: main
+
+      - name: Create Release
+        id: release
+        uses: issue-ops/releaser@v3
+        with:
+          tag: v${{ steps.tag.outputs.version }}