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

Backport of go: don't download pipeline modules when caching build modules into release/1.18.x #29238

Conversation

hc-github-team-secure-vault-core
Copy link
Collaborator

Backport

This PR is auto-generated from #29224 to be assessed for backporting due to the inclusion of the label backport/1.18.x.

The below text is copied from the body of the original PR.


Description

Various different CI jobs need Go modules in order to build or test
Vault. To speed this up in CI we cache them in Github Actions.
The caching requires downloading all modules first in order to upload
them to the actions cache, which is performed by calling the
go-mod-download Make target. This target will iterate over the
directory tree and download Go modules in all directories that include
a go.mod file.

There are two small problems with this approach that we resolved with
this PR:

  • Our go-mod-download target would download modules for all
    go.mod's present in the directory tree, regardless of whether or not
    they are required to build or test Vault. Only downloading those
    required results in slightly smaller caches.
  • tools/pipeline is intentionally a separate Go module so as to not
    require its modules in order to build Vault, however, our
    go-mod-download downloading all modules requires the workflow
    environment to include auth credentials for internal modules. If a
    community contributed PRs modifies a go.mod, which in turn requires
    a new cache, the PR will always fail because it cannot download
    modules that require secrets.

Now we avoid installing our tools/pipeline modules when generating our
module cache which should allow community contributed PRs to execute
build and Go tests, while skipping enos workflows which already required
secrets and were thus skipped.

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

Overview of commits

@hc-github-team-secure-vault-core hc-github-team-secure-vault-core force-pushed the backport/ryan/mod-download-skip-pipeline/mutually-knowing-squid branch from 3319f6d to b9f4770 Compare December 19, 2024 16:18
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Dec 19, 2024
Copy link

CI Results:
All Go tests succeeded! ✅

Copy link

Build Results:
All builds succeeded! ✅

@ryancragun ryancragun merged commit 505c302 into release/1.18.x Dec 23, 2024
90 of 91 checks passed
@ryancragun ryancragun deleted the backport/ryan/mod-download-skip-pipeline/mutually-knowing-squid branch December 23, 2024 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants