Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: ensure tags are fetched in submodule update workflow #97

Merged
merged 2 commits into from
Feb 1, 2024

Conversation

maxrake
Copy link
Contributor

@maxrake maxrake commented Jan 29, 2024

This change is to fix the error seen during the latest
CLI release, which triggered a submodule update in this
repository. That failed
in what appears to be an inability to access the requested
submodule tag. The actions/checkout action does not fetch
submodules or tags by default.

@maxrake maxrake self-assigned this Jan 29, 2024
@maxrake maxrake requested a review from a team as a code owner January 29, 2024 17:54
@maxrake maxrake requested review from kylewillmon and cd-work and removed request for texasbeef45 and joephylum January 30, 2024 20:50
@cd-work cd-work removed the request for review from kylewillmon February 1, 2024 22:21
@maxrake maxrake merged commit 0ee159c into main Feb 1, 2024
1 check passed
@maxrake maxrake deleted the fix_submodule_trigger branch February 1, 2024 23:40
maxrake added a commit that referenced this pull request Feb 2, 2024
The change in #97 was not the solution as manual trigger to the updated
workflow resulted in the same error. Further investigation revealed that
the submodule was not updated (did not have the latest commits and tags)
before the workflow attempted to checkout the newly created tag.

This change accounts for that update step. It also ensures that each
submodule command in the workflow and in documentation is acting on the
explicitly named submodule so that other submodules (which don't exist
yet but may soon) are not accidentally changed/updated.

Finally, the `actions/checkout` option to `fetch-tags` was removed since
it was determined to act on the `documentation` repo itself and not any
of the submodules. The `documentation` repo does not have any tags and
even if it did we don't need them for the submodule update workflow.
maxrake added a commit that referenced this pull request Feb 6, 2024
The change in #97 was not the solution as a manual trigger to the
updated workflow resulted in the same error. Further investigation
revealed that the submodule was not updated (did not have the latest
commits and tags) before the workflow attempted to checkout the newly
created tag.

This change accounts for that update step. It also ensures that each
submodule command in the workflow and in documentation is acting on the
explicitly named submodule so that other submodules (which don't exist
yet but may soon) are not accidentally changed/updated.

Finally, the `actions/checkout` option to `fetch-tags` was removed since
it was determined to act on the `documentation` repo itself and not any
of the submodules. The `documentation` repo does not have any tags and,
even if it did, they aren't needed for the submodule update workflow.

---------

Co-authored-by: Kyle Willmon <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants