Skip to content

Simplify checkout of submodules in GitHub workflows (with support for git describe) #3185

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

Merged
merged 2 commits into from
Jul 25, 2024

Conversation

eduar-hte
Copy link
Contributor

what

Checkout submodules in the GitHub QA workflows with the checkout action, but using the fetch-depth: 0 parameter to 'fetch all history for all tags and branches' for the git describe command to be able to identify the tag associated with each submodule's commit (if any).

why

Previously, the GitHub workflows were using the submodules: true option, but this would not include tag information about each module so git describe would not show tag information in the configure step of each build.

As a workaround, in PR #3161 the submodules option was replaced with an additional step to explicitly call git submodules init & git submodules update to address this (see changes to .github/workflows/ci.yml in commit 7732b5e).

As suggested by fzipi@ here, this could be addressed with the fetch-depth: 0 option of the checkout action (see here), simplifying the workflow again.

misc

Piggybacked simple typo in Dockerfile to build Windows version of the library introduced in commit 9e44964. 🤦

@airween airween merged commit adba86e into owasp-modsecurity:v3/master Jul 25, 2024
48 checks passed
@airween
Copy link
Member

airween commented Jul 25, 2024

Thanks @eduar-hte!

@eduar-hte eduar-hte deleted the git-describe branch August 5, 2024 17:20
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