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

infra: changelog generation #1304

Merged
merged 7 commits into from
Jan 21, 2023
Merged

Conversation

xDivisionByZerox
Copy link
Member

@xDivisionByZerox xDivisionByZerox commented Aug 26, 2022

This PR introduces configuration for our CHANGELOG file according to the standard-version package.

You can see what commands would be run, without committing to git or updating files by using the dry run mode:

  1. switch up project locally (if you haven't already)
  2. switch to this branch
  3. run npm run release -- --dry-run

I will provide a sample below.

Fixes #1244

@xDivisionByZerox xDivisionByZerox added p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision c: infra Changes to our infrastructure or project setup labels Aug 26, 2022
@xDivisionByZerox xDivisionByZerox added this to the v7 - Current Major milestone Aug 26, 2022
@xDivisionByZerox xDivisionByZerox requested a review from a team August 26, 2022 21:26
@xDivisionByZerox xDivisionByZerox self-assigned this Aug 26, 2022
@xDivisionByZerox xDivisionByZerox requested a review from a team as a code owner August 26, 2022 21:26
@xDivisionByZerox
Copy link
Member Author

xDivisionByZerox commented Aug 26, 2022

Current Dry Run Sample (will be updated regularly)

Changelog

8.0.0 (2023-01-21)

Features

Bug Fixes

  • internet: fix invalid emails in some locales (#1746) (1e4e869)
  • locale: filter inappropriate words in the en locale (#1745) (dfa647d)

New Locales

.versionrc Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 26, 2022

Codecov Report

Merging #1304 (27216e1) into next (54cc87d) will not change coverage.
The diff coverage is n/a.

❗ Current head 27216e1 differs from pull request most recent head 2b2b42e. Consider uploading reports for the commit 2b2b42e to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #1304   +/-   ##
=======================================
  Coverage   99.64%   99.64%           
=======================================
  Files        2340     2340           
  Lines      242612   242612           
  Branches     1103     1103           
=======================================
  Hits       241760   241760           
  Misses        831      831           
  Partials       21       21           

.versionrc Outdated Show resolved Hide resolved
@xDivisionByZerox xDivisionByZerox changed the title refactor: changelog generation infra: changelog generation Aug 26, 2022
@Shinigami92
Copy link
Member

That looks somewhat interesting 😲

But should we put "effort" into configuring it when we actually want to move away from that dependency?

Please be sure that the title of that linked issue is not really up to date anymore, as I'm not sure if we really want to use changesets or an alternative like described in the issue itself

But I'm heavily and in conflict with myself what would be best for the project in the long run as I didn't have build up enough knowledge yet

@xDivisionByZerox
Copy link
Member Author

But should we put "effort" into configuring it when we actually want to move away from that dependency?
[...]
But I'm heavily and in conflict with myself what would be best for the project in the long run as I didn't have build up enough knowledge yet

This didn't took too long to research. So "putting effort" into it would only be if we accept my suggestion.

Currently, this PR fixes our problem with locale changes not showing up. This should have priority.
So if we change our release package, it should also be able to be customizable as well.

@Shinigami92
Copy link
Member

But should we put "effort" into configuring it when we actually want to move away from that dependency?
[...]
But I'm heavily and in conflict with myself what would be best for the project in the long run as I didn't have build up enough knowledge yet

This didn't took too long to research. So "putting effort" into it would only be if we accept my suggestion.

Currently, this PR fixes our problem with locale changes not showing up. This should have priority. So if we change our release package, it should also be able to be customizable as well.

Yes, but on the other side we documented and changed the way how we name PR titles and so this fixed the problems with locales as well + it provided us a really helpful convention/structure of PR titles
So there is not so much randomness in the titles anymore
But this PR is not only good for showing up locales, but actually separating them from the features-segment, and that could be a good thing 🤔

.versionrc Outdated Show resolved Hide resolved
@xDivisionByZerox xDivisionByZerox force-pushed the refactor/changelog-include-locale-changes branch from 06aa9c7 to beefd46 Compare September 10, 2022 12:42
@xDivisionByZerox
Copy link
Member Author

We wait with merging till v8, to start with a "fresh" new changelog style.

@xDivisionByZerox xDivisionByZerox added s: accepted Accepted feature / Confirmed bug and removed s: needs decision Needs team/maintainer decision labels Oct 6, 2022
@ST-DDT ST-DDT enabled auto-merge (squash) January 21, 2023 18:57
@ST-DDT ST-DDT merged commit 440325e into next Jan 21, 2023
@ST-DDT ST-DDT deleted the refactor/changelog-include-locale-changes branch January 21, 2023 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: infra Changes to our infrastructure or project setup p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add more changelog sections
3 participants