Skip to content

Conversation

@rbarker-dev
Copy link
Contributor

@rbarker-dev rbarker-dev commented Jan 15, 2026

Description

This pull request introduces support for configuring submodule checkout behavior in the repository's GitHub Actions workflows and composite action. The changes add a new checkout-submodules input, update documentation to reflect the new option, and ensure the value is correctly passed through workflow jobs and actions.

Support for submodule checkout in workflows and actions:

  • Added a new checkout-submodules input to action.yml, allowing users to specify whether submodules should be fetched during checkout (true, false, or recursive).
  • Updated the composite action to echo the value of checkout-submodules and to pass it to the actions/checkout step. [1] [2]
  • Updated workflow jobs in .github/workflows/test.yml to set checkout-submodules: false where appropriate. [1] [2]

Documentation updates:

  • Enhanced the README.md to document the new checkout-submodules input, including its description, default value, and options.

Related Issue(s)

Closes #16

Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
Copilot AI review requested due to automatic review settings January 15, 2026 18:26
@rbarker-dev rbarker-dev linked an issue Jan 15, 2026 that may be closed by this pull request
@rbarker-dev rbarker-dev self-assigned this Jan 15, 2026
@rbarker-dev rbarker-dev added the enhancement Enhancement or request for existing feature label Jan 15, 2026
Copy link
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 pull request adds support for checking out Git submodules in the GitHub Action workflow by introducing a new checkout-submodules input parameter. The change enables users to specify whether submodules should be fetched during the checkout process, with support for true, false, or recursive values.

Changes:

  • Added checkout-submodules input parameter to the action configuration with a default value of false
  • Updated checkout logging to display the submodules configuration value
  • Modified the checkout step to pass the submodules parameter to the underlying actions/checkout action
  • Updated documentation and test workflows to reflect the new parameter

Reviewed changes

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

File Description
action.yml Added checkout-submodules input definition, logging output, and parameter passing to checkout action
README.md Added checkout-submodules parameter documentation to the Repository Checkout table
.github/workflows/test.yml Added checkout-submodules: false to test workflows to exercise the new parameter

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

Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
Copy link
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

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


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

@rbarker-dev rbarker-dev merged commit ffb7446 into main Jan 15, 2026
16 checks passed
@rbarker-dev rbarker-dev deleted the 16-add-submodules-for-checkout-code-step branch January 15, 2026 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Enhancement or request for existing feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add submodules for checkout code step

3 participants