faker icon indicating copy to clipboard operation
faker copied to clipboard

infra: changelog generation

Open xDivisionByZerox opened this issue 3 years ago • 5 comments

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 avatar Aug 26 '22 21:08 xDivisionByZerox

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

xDivisionByZerox avatar Aug 26 '22 21:08 xDivisionByZerox

Codecov Report

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

:exclamation: 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           

codecov[bot] avatar Aug 26 '22 21:08 codecov[bot]

That looks somewhat interesting 😲

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

  • #1096

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

Shinigami92 avatar Aug 26 '22 21:08 Shinigami92

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.

xDivisionByZerox avatar Aug 26 '22 21:08 xDivisionByZerox

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 :thinking:

Shinigami92 avatar Aug 26 '22 21:08 Shinigami92

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

xDivisionByZerox avatar Oct 06 '22 16:10 xDivisionByZerox