-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
chore: Call shardstreams.Config
by value instead of by reference
#12915
Conversation
This PR must be merged before a backport PR will be created. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-12915-to-release-3.0.x origin/release-3.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x afd9e363065ee2bb07844f8dbb30cc8dfb310c9d When the conflicts are resolved, stage and commit the changes:
If you have the GitHub CLI installed: # Push the branch to GitHub:
git push --set-upstream origin backport-12915-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 12915 --json body --template 'Backport afd9e363065ee2bb07844f8dbb30cc8dfb310c9d from #12915{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title "chore: [release-3.0.x] chore: Call `shardstreams.Config` by value instead of by reference" --body-file - --label "size/M" --label "type/docs" --label "backport" --base release-3.0.x --milestone release-3.0.x --web Or, if you don't have the GitHub CLI installed (we recommend you install it!): # Push the branch to GitHub:
git push --set-upstream origin backport-12915-to-release-3.0.x
# Create a pull request where the `base` branch is `release-3.0.x` and the `compare`/`head` branch is `backport-12915-to-release-3.0.x`.
# Remove the local backport branch
git switch main
git branch -D backport-12915-to-release-3.0.x |
What this PR does / why we need it:
Use
shardstreams.Config
by value instead of by reference to fix docs generation.Our
docs-generator
tool relies on the struct address/references to assume that flags are present. Using this config by value fixes it.Which issue(s) this PR fixes:
Fixes #12904
Special notes for your reviewer:
Checklist
CONTRIBUTING.md
guide (required)feat
PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.md
production/helm/loki/Chart.yaml
and updateproduction/helm/loki/CHANGELOG.md
andproduction/helm/loki/README.md
. Example PRdeprecated-config.yaml
anddeleted-config.yaml
files respectively in thetools/deprecated-config-checker
directory. Example PR