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

[Improvement] Documentation: Changelog generation #7

Closed
fuhlig opened this issue Sep 14, 2019 · 4 comments
Closed

[Improvement] Documentation: Changelog generation #7

fuhlig opened this issue Sep 14, 2019 · 4 comments
Assignees
@csshugs
Labels
improvement Change or improve existing feature

Comments

@fuhlig
Copy link
Collaborator

fuhlig commented Sep 14, 2019 •
edited by csshugs
Loading

Good choice by using conventional commits.
This layed the groundwork for automation:

Let me know what you think and we can break those tasks (evaluation, implementation etc.) down
@fuhlig fuhlig added the improvement Change or improve existing feature label Sep 14, 2019
@csshugs
Copy link
Owner

csshugs commented Sep 19, 2019 •
edited
Loading

Ok, I already checked out standard-version. I have a poc-branch open, so you can check it out. The CHANGELOG.md generation happens via a $ npm run release. This works well, but really forces us to squash our commits when merging PRs. Otherwise every commit is regarded as an individual entry in the generated changelog. I’m fine with squashing commits. The question is how to lint them when squashing via the GitHub UI.

@csshugs
Copy link
Owner

csshugs commented Sep 27, 2019 •
edited
Loading

Or should we rather just squash manually (locally) when merging develop into master?

@csshugs
Copy link
Owner

csshugs commented Sep 27, 2019 •
edited
Loading

Apart from all that, I think that linting commits is a really good idea and we can tackle that as a separate feature, as I consider that independent from changelog generation.

@fuhlig I've taken the liberty of updating your initial comment and changing the issue title accordingly.

See #9

@csshugs csshugs mentioned this issue Sep 27, 2019
Closed
@csshugs csshugs changed the title [Improvement] Documentation: Commit automation [Improvement] Documentation: Changelog generation Sep 27, 2019
csshugs added a commit that referenced this issue Dec 17, 2019
@csshugs
refactor: add extra changelog section for docs (#7)
0afb35e 
because:
- it could benefit users who explicitly search the changelog for
documentation fixes or additions

this commit:
- adds a separate changelog section for documentation changes
csshugs added a commit that referenced this issue Dec 17, 2019
@csshugs
build: use fixed versions for npm packages (#7)
751d36d 
because:
- we want the exact same dependencies on everyones machine and on the
build servers

this commit:
- sets the `save-exact=true` flag in `.npmrc`
- removes the `^` in front of every version number in the
`package.json`s dependencies.

BREAKING CHANGE: run `npx rimraf node_modules/ && npm install` to
definitely install the correct dependencies on your machine
csshugs added a commit that referenced this issue Dec 17, 2019
@csshugs
refactor: extract changelog config to separate file (#7)
3905338 
because:
- we want to keep a separation of concerns
- we want to keep things clear

this commit:
- creates a `.versionrc` file which contains all the changelog
config necessary for the `standard-version` package
csshugs added a commit that referenced this issue Jan 6, 2020
@csshugs
refactor: add extra changelog section for docs (#7)
69f1628 
because:
- it could benefit users who explicitly search the changelog for
documentation fixes or additions

this commit:
- adds a separate changelog section for documentation changes
csshugs added a commit that referenced this issue Jan 6, 2020
@csshugs
build: use fixed versions for npm packages (#7)
1b4242d 
because:
- we want the exact same dependencies on everyones machine and on the
build servers

this commit:
- sets the `save-exact=true` flag in `.npmrc`
- removes the `^` in front of every version number in the
`package.json`s dependencies.

BREAKING CHANGE: run `npx rimraf node_modules/ && npm install` to
definitely install the correct dependencies on your machine
csshugs added a commit that referenced this issue Jan 6, 2020
@csshugs
refactor: extract changelog config to separate file (#7)
ddb4484 
because:
- we want to keep a separation of concerns
- we want to keep things clear

this commit:
- creates a `.versionrc` file which contains all the changelog
config necessary for the `standard-version` package
csshugs added a commit that referenced this issue Jan 13, 2020
@csshugs
build: provide automatic changelog generation (#7)
3bb85fb 
Signed-off-by: Dennis Heibült <mail@dennisheibuelt.com>

build: add .editorconfig

apart from the fact that an .editorconfig file is a good thing in
general, it is necessary now so we can create nested markdown lists.

docs: provide release guidelines

refactor: add extra changelog section for docs (#7)

because:
- it could benefit users who explicitly search the changelog for
documentation fixes or additions

this commit:
- adds a separate changelog section for documentation changes

refactor: extract changelog config to separate file (#7)

because:
- we want to keep a separation of concerns
- we want to keep things clear

this commit:
- creates a `.versionrc` file which contains all the changelog
config necessary for the `standard-version` package

build: use fixed versions for npm packages (#7)

because:
- we want the exact same dependencies on everyones machine and on the
build servers

this commit:
- sets the `save-exact=true` flag in `.npmrc`
- removes the `^` in front of every version number in the
`package.json`s dependencies.

BREAKING CHANGE: run `npx rimraf node_modules/ && npm install` to
definitely install the correct dependencies on your machine
csshugs added a commit that referenced this issue Jan 13, 2020
@csshugs
build: provide automatic changelog generation (#7)
a3b5710 
Signed-off-by: Dennis Heibült <mail@dennisheibuelt.com>

build: add .editorconfig

apart from the fact that an .editorconfig file is a good thing in
general, it is necessary now so we can create nested markdown lists.

docs: provide release guidelines

refactor: add extra changelog section for docs (#7)

because:
- it could benefit users who explicitly search the changelog for
documentation fixes or additions

this commit:
- adds a separate changelog section for documentation changes

refactor: extract changelog config to separate file (#7)

because:
- we want to keep a separation of concerns
- we want to keep things clear

this commit:
- creates a `.versionrc` file which contains all the changelog
config necessary for the `standard-version` package

build: use fixed versions for npm packages (#7)

because:
- we want the exact same dependencies on everyones machine and on the
build servers

this commit:
- sets the `save-exact=true` flag in `.npmrc`
- removes the `^` in front of every version number in the
`package.json`s dependencies.

BREAKING CHANGE: run `npx rimraf node_modules/ && npm install` to
definitely install the correct dependencies on your machine
@csshugs
Copy link
Owner

csshugs commented Jan 13, 2020

#17 is merged.

@csshugs csshugs closed this as completed Jan 13, 2020
csshugs added a commit that referenced this issue Feb 3, 2020
@csshugs
build: provide automatic changelog generation (#7)
e6a3be6 
Signed-off-by: Dennis Heibült <mail@dennisheibuelt.com>

build: add .editorconfig

apart from the fact that an .editorconfig file is a good thing in
general, it is necessary now so we can create nested markdown lists.

docs: provide release guidelines

refactor: add extra changelog section for docs (#7)

because:
- it could benefit users who explicitly search the changelog for
documentation fixes or additions

this commit:
- adds a separate changelog section for documentation changes

refactor: extract changelog config to separate file (#7)

because:
- we want to keep a separation of concerns
- we want to keep things clear

this commit:
- creates a `.versionrc` file which contains all the changelog
config necessary for the `standard-version` package

build: use fixed versions for npm packages (#7)

because:
- we want the exact same dependencies on everyones machine and on the
build servers

this commit:
- sets the `save-exact=true` flag in `.npmrc`
- removes the `^` in front of every version number in the
`package.json`s dependencies.

BREAKING CHANGE: run `npx rimraf node_modules/ && npm install` to
definitely install the correct dependencies on your machine
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@csshugs csshugs

Labels
improvement Change or improve existing feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@fuhlig @csshugs