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

Improve changelog rules #981

Merged
merged 4 commits into from
Feb 20, 2023
Merged

Improve changelog rules #981

merged 4 commits into from
Feb 20, 2023

Conversation

MattiSG
Copy link
Member

@MattiSG MattiSG commented Dec 12, 2022

Through learning about writing our changelog in #979, @Ndpnt and I listed additional rules.

### Added
- Load both the configurations defined in this module and the configurations defined in the module which use it as dependency.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently the tool we use remove blank lines around titles and lists. So if we make this change we will have inconsistency in changelog. I opened an issue on the tool, let's wait for a response. Otherwise, we have to fork the tool and make the change.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Ndpnt is that blocking for you?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please “request changes” then? That will make advancement easier to track 🙂

Copy link
Member

@martinratinaud martinratinaud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice and clear

Copy link
Member

@Ndpnt Ndpnt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update tool that generate changelog before to avoid spacing inconsistencies.

@Ndpnt
Copy link
Member

Ndpnt commented Jan 25, 2023

I opened an issue on the GitHub action that generate changelog superfaceai/release-changelog-action#269

@Ndpnt
Copy link
Member

Ndpnt commented Feb 20, 2023

I opened an issue on the GitHub action that generate changelog superfaceai/release-changelog-action#269

Github action updated. I tested that it properly fix the format on a fork here

@Ndpnt Ndpnt merged commit 7357c40 into main Feb 20, 2023
@Ndpnt Ndpnt deleted the changelog branch February 20, 2023 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants