generoi / genero-design-system

https://gds.generogrowth.com/
MIT License
4 stars 0 forks source link

feat: automate changelog #16

Closed silentnoodlemaster closed 4 years ago

silentnoodlemaster commented 4 years ago

we should still discuss:

todo:

closes #15

silentnoodlemaster commented 4 years ago

alternatively commitizen instead of commitlint

(or both)

taromorimoto commented 4 years ago

How does the automatic versioning work?

silentnoodlemaster commented 4 years ago

@taromorimoto

How does the automatic versioning work?

this readme will explain it better than i ever could https://github.com/conventional-changelog/standard-version

oxyc commented 4 years ago

I think I personally need commitlint/commitizen in the beginning to get used to it :D if we want we can always drop it later.

So we should also update https://github.com/generoi/genero-design-system#publishing-a-new-version

Something like:

# Create release, generate changelog and bump the version based on commit log
npm run release
# Create a named prerelease version
npm run release -- --prerelease beta
# Manually specifify the version bump
npm run release -- --release-as minor
npm run release -- --release-as 1.1.0

# Push and publish release
git push
git push --tags
npm publish
oxyc commented 4 years ago

If we do, should we point people to https://www.conventionalcommits.org/en/v1.0.0/ or will the lint error be descriptive enough to lead people there?

taromorimoto commented 4 years ago

If we do, should we point people to https://www.conventionalcommits.org/en/v1.0.0/ or will the lint error be descriptive enough to lead people there?

I would imagine that the lint error should be enough. The readme will anyways talk about using this.

taromorimoto commented 4 years ago

@silentnoodlemaster can you add @oxyc's suggestions to readme and merge?