Skip to content

feat: Update inputs for egress policy and additional checkout options#64

Merged
rbarker-dev merged 2 commits into
mainfrom
63-add-support-for-step-security-egress-policy-changes
May 19, 2026
Merged

feat: Update inputs for egress policy and additional checkout options#64
rbarker-dev merged 2 commits into
mainfrom
63-add-support-for-step-security-egress-policy-changes

Conversation

@rbarker-dev
Copy link
Copy Markdown
Contributor

Description

This pull request introduces several enhancements and new configuration options for the GitHub Actions workflow and composite action, focusing on improved security, flexibility in repository checkout, and better output reporting. The most significant changes are the addition of configurable egress policy for security hardening, expanded checkout options, and improved documentation and outputs for consumers of the action.

Security and Egress Policy:

  • Added a configurable egress-policy input to the composite action and workflow, allowing users to set the Step Security Harden Runner to either audit (default) or block mode for network egress control. A new job was added to test this input, and documentation was updated to explain its usage. [1] [2] [3] [4] [5] [6] [7]

Repository Checkout Enhancements:

  • Introduced new inputs for checkout customization: checkout-path (specifies the directory to checkout into, defaulting to .) and checkout-persist (controls whether credentials are persisted, defaulting to true). These are now passed to the checkout step and documented. [1] [2] [3] [4]

Output Improvements:

  • Added new outputs: checkout-path (reports the checkout directory) and node-registry-url (reports the Node.js registry used). Workflow steps were updated to display these outputs for easier debugging and traceability. [1] [2] [3] [4] [5]

Documentation Updates:

  • Expanded the README.md to document the new inputs and outputs, including detailed tables and usage examples for egress policy, checkout options, and Node.js registry configuration. [1] [2] [3] [4] [5] [6]

These changes provide improved security configurability, greater flexibility for repository checkout, and clearer outputs and documentation for users of the action.

Related Issue(s)

Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
@rbarker-dev rbarker-dev self-assigned this May 19, 2026
@rbarker-dev rbarker-dev added the feature New Feature label May 19, 2026
Copilot AI review requested due to automatic review settings May 19, 2026 19:28
@rbarker-dev rbarker-dev added the github_actions Changes to github actions label May 19, 2026
@rbarker-dev rbarker-dev linked an issue May 19, 2026 that may be closed by this pull request
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR expands the composite action and its test workflow to support configurable Harden Runner egress policy, additional repository checkout customization, and extra outputs/documentation to improve consumer visibility.

Changes:

  • Added an egress-policy input and a new CI job intended to validate egress-policy configuration.
  • Added checkout customization inputs (checkout-path, checkout-persist) and threaded them through to actions/checkout.
  • Added/updated action outputs and README documentation (including checkout-path and Node registry reporting).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
README.md Documents the new Harden Runner/checkout inputs and adds new output descriptions and examples.
action.yml Implements new inputs and wires them into Harden Runner + checkout; introduces new outputs.
.github/workflows/test.yml Updates the integration test job to pass/print new inputs/outputs and adds a new egress-policy test job.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread action.yml Outdated
Comment thread .github/workflows/test.yml Outdated
Comment thread .github/workflows/test.yml
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
@rbarker-dev rbarker-dev merged commit c392c3e into main May 19, 2026
14 checks passed
@rbarker-dev rbarker-dev deleted the 63-add-support-for-step-security-egress-policy-changes branch May 19, 2026 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New Feature github_actions Changes to github actions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add support for step-security egress policy changes Add a checkout-path option

3 participants