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

explain how -output-curl-string works in comments to avoid confusion #28576

Merged
merged 1 commit into from
Oct 4, 2024

Conversation

raskchanky
Copy link
Contributor

@raskchanky raskchanky commented Oct 2, 2024

Description

Resolves #25213

There is some confusion in the code around how -output-curl-string actually works, so I attempted to explain it in some comments.

TODO only if you're a HashiCorp employee

  • Backport Labels: If this PR is in the ENT repo and needs to be backported, backport
    to N, N-1, and N-2, using the backport/ent/x.x.x+ent labels. If this PR is in the CE repo, you should only backport to N, using the backport/x.x.x label, not the enterprise labels.
    • 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.

@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Oct 2, 2024
@raskchanky
Copy link
Contributor Author

Given that this doesn't functionally change anything about how Vault works, I don't think it requires a changelog, milestone, or backport.

Copy link

github-actions bot commented Oct 2, 2024

CI Results:
All required Go tests succeeded but failures were detected ⚠️
Failures:

Test Type Package Test Logs
race vault TestExternalPluginInContainer_MountAndUnmount view test results
race vault TestExternalPluginInContainer_MountAndUnmount/rootful_docker_runtimes view test results

Copy link

github-actions bot commented Oct 2, 2024

Build Results:
All builds succeeded! ✅

Copy link
Contributor

@VioletHynes VioletHynes left a comment

Choose a reason for hiding this comment

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

This is really awesome. Reading through these, it's immediately obvious the value they provide. Thanks for this! :D

@raskchanky raskchanky merged commit d1355cb into main Oct 4, 2024
90 of 94 checks passed
@raskchanky raskchanky deleted the explain-output-curl branch October 4, 2024 18:14
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.

Error() call not returning the curl string as expected
2 participants