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.

Sign up for GitHub

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

Jump to bottom

Remove scripts/changelog.js in favor of GitHub's automatic changelog generation #4370

Closed
wants to merge 1 commit into from
Closed

Remove scripts/changelog.js in favor of GitHub's automatic changelog generation #4370

wants to merge 1 commit into from

Conversation

MaxLeiter
Copy link
Member

@MaxLeiter MaxLeiter commented Nov 23, 2021 •
edited

There's now a button when creating GitHub releases that offers to auto-generate a changelog. The result won't be as fancy or in-depth, but it would be easier to curate. I'm open to closing w/o merging if people feel strongly about keeping the existing script.

Here's what github generates for 4.3 (with no editing by me, and note that I don't think releases renders the inline PR information, it instead just links the #PR):

What's Changed

New Contributors

Full Changelog: v4.2.0...v4.3.0

@MaxLeiter MaxLeiter added this to the 4.3.1 milestone Nov 23, 2021
@termermc
Copy link

termermc commented Nov 23, 2021 via email

@MaxLeiter
Copy link
Member Author

The custom script uses the github API, @termermc

@termermc
Copy link

termermc commented Nov 23, 2021 via email

@ghost
Copy link

ghost commented Nov 23, 2021

As it is, that's...very verbose. I feel like dependabot/renovate stuff, in particular, could be condensed significantly to something like:

The rest of it is just looks a lot of repetition, based on how GitHub renders stuff (at least, this is what I see).

@dgw
Copy link
Contributor

dgw commented Nov 23, 2021

The rest of it is just looks a lot of repetition, based on how GitHub renders stuff (at least, this is what I see).

Ah yes, the unilateral rendering change that should have been a new syntax instead and annoyed a bunch of maintainers whose task lists and other old issues suddenly had mountains of redundant text, the disruptiveness of which GitHub has never (AFAIK) acknowledged.

Interesting that the changelog tool generates this format, unless expanding inline issue/PR references is disabled in release descriptions.

@MaxLeiter
Copy link
Member Author

Interesting that the changelog tool generates this format, unless expanding inline issue/PR references is disabled in release descriptions.

I believe that is the case

@brunnre8
Copy link
Member

You're the maintainer who has to do it, in other words no pushback of any kind from my side.
You get to choose your tools.

@xPaw
Copy link
Member

xPaw commented Nov 23, 2021

Yeah as usual with these automatic generation its very verbose. How does that compare to our tool? (Did it break?)

@xPaw
Copy link
Member

xPaw commented Nov 23, 2021

Perhaps if configured it can get much more closer to what we had: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes

@MaxLeiter
Copy link
Member Author

Closing for now, not too many benefits and would require us to work on the changelog previewer in settings.

@MaxLeiter MaxLeiter closed this Feb 9, 2022
@MaxLeiter MaxLeiter deleted the rmChangelogScript branch February 9, 2022 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
4.3.1
Development

Successfully merging this pull request may close these issues.

SOCKS proxy support over corporate network
5 participants
@MaxLeiter @termermc @dgw @brunnre8 @xPaw