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

Update CHANGELOG.md for telemetry changes #2923

Merged
merged 1 commit into from
Oct 9, 2023

Conversation

robertbrignull
Copy link
Contributor

Update the changelog for #2824, because I forgot to do it in the PR.

Links to the docs which will be updated by github/codeql#14408

Checklist

  • CHANGELOG.md has been updated to incorporate all user visible changes made by this pull request.
  • Issues have been created for any UI or other user-facing changes made by this pull request.
  • [Maintainers only] If this pull request makes user-facing changes that require documentation changes, open a corresponding docs pull request in the github/codeql repo and add the ready-for-doc-review label there.

@robertbrignull robertbrignull requested a review from a team October 9, 2023 10:09
@robertbrignull robertbrignull requested a review from a team as a code owner October 9, 2023 10:09
Copy link
Contributor

@shati-patel shati-patel left a comment

Choose a reason for hiding this comment

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

Looks good!
Worth noting that the docs normally get updated once every 2 weeks, with a CLI release, so we probably won't be able to coordinate this exactly. Do we want to leave out this changelog entry until after the docs have definitely been released? (I don't mind either way, it's a small enough change 😄)

@robertbrignull
Copy link
Contributor Author

Worth noting that the docs normally get updated once every 2 weeks, with a CLI release, so we probably won't be able to coordinate this exactly. Do we want to leave out this changelog entry until after the docs have definitely been released?

I don't mind too much. I also don't think it's too bad if the docs take an extra week to be updated.

Technically the docs are still correct since we also respect the old setting, but I realise that might be confusing when reading the changelog.

I think I'd err on the side of merging it so that the changelog matches the code change.

@robertbrignull robertbrignull merged commit 603c799 into main Oct 9, 2023
@robertbrignull robertbrignull deleted the robertbrignull/telemetry-changelog branch October 9, 2023 11:24
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