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

Changelog formatting #1246

Merged
merged 2 commits into from May 22, 2020
Merged

Changelog formatting #1246

merged 2 commits into from May 22, 2020

Conversation

hipstersmoothie
Copy link
Collaborator

@hipstersmoothie hipstersmoothie commented May 22, 2020

What Changed

This PR addresses a few things about how the changelogs are formatted:

  • Fix extra space in "Push to master" changelog title
  • Strip consecutive whitespace in PR titles/commit messages
  • Add newline to end of new changelogs

There still might be a chance for a changelog to have bad formatting (ex: release notes).
To fix this would would have to depend on prettier and formate the PR/commit bodies as well.
I don't really want to do that.

I also ran the formatting over all committed changelogs.

Why

closes #1186

Todo:

  • Add tests
📦 Published PR as canary version: under canary scope @auto-canary@9.35.2-canary.1246.15956.0

✨ Test out this PR locally via:

npm install @auto-canary/bot-list@9.35.2-canary.1246.15956.0
npm install @auto-canary/auto@9.35.2-canary.1246.15956.0
npm install @auto-canary/core@9.35.2-canary.1246.15956.0
npm install @auto-canary/all-contributors@9.35.2-canary.1246.15956.0
npm install @auto-canary/brew@9.35.2-canary.1246.15956.0
npm install @auto-canary/chrome@9.35.2-canary.1246.15956.0
npm install @auto-canary/cocoapods@9.35.2-canary.1246.15956.0
npm install @auto-canary/conventional-commits@9.35.2-canary.1246.15956.0
npm install @auto-canary/crates@9.35.2-canary.1246.15956.0
npm install @auto-canary/exec@9.35.2-canary.1246.15956.0
npm install @auto-canary/first-time-contributor@9.35.2-canary.1246.15956.0
npm install @auto-canary/gem@9.35.2-canary.1246.15956.0
npm install @auto-canary/gh-pages@9.35.2-canary.1246.15956.0
npm install @auto-canary/git-tag@9.35.2-canary.1246.15956.0
npm install @auto-canary/gradle@9.35.2-canary.1246.15956.0
npm install @auto-canary/jira@9.35.2-canary.1246.15956.0
npm install @auto-canary/maven@9.35.2-canary.1246.15956.0
npm install @auto-canary/npm@9.35.2-canary.1246.15956.0
npm install @auto-canary/omit-commits@9.35.2-canary.1246.15956.0
npm install @auto-canary/omit-release-notes@9.35.2-canary.1246.15956.0
npm install @auto-canary/released@9.35.2-canary.1246.15956.0
npm install @auto-canary/s3@9.35.2-canary.1246.15956.0
npm install @auto-canary/slack@9.35.2-canary.1246.15956.0
npm install @auto-canary/twitter@9.35.2-canary.1246.15956.0
npm install @auto-canary/upload-assets@9.35.2-canary.1246.15956.0
# or 
yarn add @auto-canary/bot-list@9.35.2-canary.1246.15956.0
yarn add @auto-canary/auto@9.35.2-canary.1246.15956.0
yarn add @auto-canary/core@9.35.2-canary.1246.15956.0
yarn add @auto-canary/all-contributors@9.35.2-canary.1246.15956.0
yarn add @auto-canary/brew@9.35.2-canary.1246.15956.0
yarn add @auto-canary/chrome@9.35.2-canary.1246.15956.0
yarn add @auto-canary/cocoapods@9.35.2-canary.1246.15956.0
yarn add @auto-canary/conventional-commits@9.35.2-canary.1246.15956.0
yarn add @auto-canary/crates@9.35.2-canary.1246.15956.0
yarn add @auto-canary/exec@9.35.2-canary.1246.15956.0
yarn add @auto-canary/first-time-contributor@9.35.2-canary.1246.15956.0
yarn add @auto-canary/gem@9.35.2-canary.1246.15956.0
yarn add @auto-canary/gh-pages@9.35.2-canary.1246.15956.0
yarn add @auto-canary/git-tag@9.35.2-canary.1246.15956.0
yarn add @auto-canary/gradle@9.35.2-canary.1246.15956.0
yarn add @auto-canary/jira@9.35.2-canary.1246.15956.0
yarn add @auto-canary/maven@9.35.2-canary.1246.15956.0
yarn add @auto-canary/npm@9.35.2-canary.1246.15956.0
yarn add @auto-canary/omit-commits@9.35.2-canary.1246.15956.0
yarn add @auto-canary/omit-release-notes@9.35.2-canary.1246.15956.0
yarn add @auto-canary/released@9.35.2-canary.1246.15956.0
yarn add @auto-canary/s3@9.35.2-canary.1246.15956.0
yarn add @auto-canary/slack@9.35.2-canary.1246.15956.0
yarn add @auto-canary/twitter@9.35.2-canary.1246.15956.0
yarn add @auto-canary/upload-assets@9.35.2-canary.1246.15956.0

@hipstersmoothie hipstersmoothie added the patch Increment the patch version when merged label May 22, 2020
@codecov
Copy link

codecov bot commented May 22, 2020

Codecov Report

Merging #1246 into master will increase coverage by 0.02%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1246      +/-   ##
==========================================
+ Coverage   80.84%   80.87%   +0.02%     
==========================================
  Files          56       56              
  Lines        4051     4057       +6     
  Branches      874      831      -43     
==========================================
+ Hits         3275     3281       +6     
  Misses        552      552              
  Partials      224      224              
Impacted Files Coverage Δ
packages/core/src/changelog.ts 95.89% <ø> (ø)
packages/core/src/log-parse.ts 100.00% <100.00%> (ø)
packages/core/src/release.ts 94.57% <100.00%> (+0.02%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6dd1754...4540b32. Read the comment docs.

@hipstersmoothie hipstersmoothie merged commit a574fec into master May 22, 2020
@hipstersmoothie hipstersmoothie deleted the changelog-formatting branch May 22, 2020 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
patch Increment the patch version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant