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

fix: changelog generation formatting RE-3152 #15060

Merged
merged 4 commits into from
Nov 4, 2024
Merged

Conversation

erikburt
Copy link
Collaborator

@erikburt erikburt commented Oct 31, 2024

Changes

  • Switch from @changesets/changelog-github to a local file which doesn't include users in the changelog generation
    • This applies to both the root .changesets, and the contracts/.changesets configs
  • Updated package.jsons to remove the unused dependency, and explicitly declare the pre-existing transitive dependency which is now referenced in the changelog generation code

Testing

Tested locally, new format of changelog is like:

# Changelog Chainlink Core

## 2.19.0

### Minor Changes

- [#14898](https://github.com/smartcontractkit/chainlink/pull/14898) [`a417740`](https://github.com/smartcontractkit/chainlink/commit/a41774035961ce88be2fed7c6759758a7f00881d) - Bump to start the next version

...

RE-3152

Since this is for NOPs and the names can be unprofessional and it adds unwanted noise, we’d like to remove the thanks @ghusername in the changesets generated changelogs.

@erikburt erikburt self-assigned this Oct 31, 2024
@erikburt erikburt marked this pull request as ready for review October 31, 2024 20:45
@erikburt erikburt requested review from a team as code owners October 31, 2024 20:45
@erikburt erikburt requested a review from pavel-raykov October 31, 2024 20:45
@erikburt erikburt requested a review from a team as a code owner October 31, 2024 20:48
@cl-sonarqube-production
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@momentmaker
Copy link
Contributor

nice! should we also do this for changeset in contracts?

@erikburt
Copy link
Collaborator Author

nice! should we also do this for changeset in contracts?

@momentmaker, it's already included in this PR.

@momentmaker
Copy link
Contributor

nice! should we also do this for changeset in contracts?

@momentmaker, it's already included in this PR.

ahh sorry - totally missed it

@pavel-raykov
Copy link
Collaborator

Changes

  • Switch from @changesets/changelog-github to a local file which doesn't include users in the changelog generation

    • This applies to both the root .changesets, and the contracts/.changesets configs
  • Updated package.jsons to remove the unused dependency, and explicitly declare the pre-existing transitive dependency which is now referenced in the changelog generation code

Testing

Tested locally, new format of changelog is like:

# Changelog Chainlink Core

## 2.19.0

### Minor Changes

- [#14898](https://github.com/smartcontractkit/chainlink/pull/14898) [`a417740`](https://github.com/smartcontractkit/chainlink/commit/a41774035961ce88be2fed7c6759758a7f00881d) - Bump to start the next version

...

RE-3152

Would it be possible to give an example of the changelog generation before and after this change?

Also, stupid question - could one just use '@changesets/changelog-github' and then do some filtering to remove usernames? (or is this as hard as forking the changelog)

@momentmaker
Copy link
Contributor

i don't think you can config it and what's @erikburt created the custom formatter.
https://github.com/changesets/changesets/blob/7323704dff6e76f488370db384579b86c95c866f/packages/changelog-github/src/index.ts#L116

and the example he gave in the description is the after and you can see the current changelog to see how currently is.

@pavel-raykov
Copy link
Collaborator

i don't think you can config it and what's @erikburt created the custom formatter. changesets/changesets@7323704/packages/changelog-github/src/index.ts#L116

and the example he gave in the description is the after and you can see the current changelog to see how currently is.

Thanks, and what is the purpose of hiding the usernames - is this some privacy issue?

@momentmaker
Copy link
Contributor

don't think so but more so a request from the core team - probably because of annoyance of getting tagged

@pavel-raykov
Copy link
Collaborator

don't think so but more so a request from the core team - probably because of annoyance of getting tagged

Ok, @erikburt could you please update the description with the motivation for this change. Thanks!

@erikburt erikburt enabled auto-merge November 1, 2024 23:07
@erikburt erikburt added this pull request to the merge queue Nov 4, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 4, 2024
@RensR RensR added this pull request to the merge queue Nov 4, 2024
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.

5 participants