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

✨ feat(changelog): add style configs #669

Merged
merged 11 commits into from Jun 10, 2023
Merged

✨ feat(changelog): add style configs #669

merged 11 commits into from Jun 10, 2023

Conversation

canisminor1990
Copy link
Contributor

@canisminor1990 canisminor1990 commented Jun 7, 2023 •
edited

Add configs showAuthorAvatar showSummary reduceHeadingLevel newlineTimestamp addBackToTop

interface ChangelogConfig {
  /**
   * title language
   * @default en-US
   */
  titleLanguage?: 'en-US' | 'zh-CN' | 'mix';
  /**
   * whether to show author avatar
   * @default false
   */
  showAuthorAvatar?: boolean;
  /**
   * whether to show summary
   * @default false
   */
  showSummary?: boolean;
  /**
   * reduce heading level from # to ##
   * @default false
   */
  reduceHeadingLevel?: boolean;
  /**
   * put timestamp to second line
   * @default false
   */
  newlineTimestamp?: boolean;
  /**
   * add back to top button
   * @default false
   */
  addBackToTop?: boolean;
}

Changelog Demo

// .changelogrc.js

module.exports = {
  titleLanguage: 'mix',
  showAuthor: true,
  showAuthorAvatar: true,
  newlineTimestamp: true,
  reduceHeadingLevel: true,
  addBackToTop: true,
  showSummary: true,
  scopeDisplayName: {
    '*': 'misc',
  },
};

Version 1.4

Released on 2023-06-07

✨ Features | 新特性

  • changelog: Add chinese title, add configs showAuthorAvatar showSummary reduceHeadingLevel newlineTimestamp addBackToTop, add gitmoji changelog config, add scopeDisplayName config, add summary avatar list, add type display config, better summary style, bump up version, empty to bump up version.
  • commit-type: Extract commit-type package, extract commit-type package, extract commit-type package.
  • commit-types: Add wip types.
  • config-monorepo: Add modules, add scope lint.
  • config: Support more config type, support more config type.
  • description: Update package description.
  • i18n: Support on or off emoji, support switch language.
  • parser-opts: Add custom config, extract parser-opts packages, support parsing Chinese, support UCS-4 unicode.
  • misc: Add emoji rule, add git options, add github config, add new monorepo params to work with monorepo, add new monorepo params to work with monorepo, add new release configuration, add npm config, add npm config, add rc release config, add style and build to release rule, support config creator, support gitmoji unicode, support GITMOJI_PATH env, support GITMOJI_PATH env, support GITMOJI_PATH env, support local gitmoji path, support release on main branch, support release on main branch, support UCS-4 emoji unicode, support unicode parsing, update to new version.

🐛 Bug Fixes | 修复

  • changelog: 修正日志配置, 修正日志配置, fix style type display name, fix summary spacing, footer position, remove scope brace.
  • commit-types: Add test documents.
  • commitlint-config: Upgrade header-max-length config in commitlint.
  • config-monorepo: Add test, add test config, fix version error, test monorepo.
  • config: 修正日志版本, fix a subject bug, fix version, fix version, fix version, fix version.
  • package: Clean unused files in package.
  • parser-opts: 优化脚本, fix package description, fix package description, fix package description, fix package description.
  • plugin: Fix version, fix version, fix version, throw better fetch failed msg.
  • release-config: Fix beta release config.
  • misc: 修正 changelog 日志问题, 修正找不到 createConfig 模块的错误, add declaration, allow parenthesis around ticket number, clean changelog, clean changelog, corrected grammar of complaint message, fix alpha release problem, fix can't find createConfig, fix can't find default, fix config export error, fix dependency error, fix error message reference url, fix error when there is no changelog config, fix github rate limit on release, fix missing module.exports when migration to father4, fix package description, fix package homepage, fix parser success without gitmoji, link deps, try to fix gitmoji unicode regex, try to fix release issue by lock gitmojis version.

Improvements and Fixes
What's improved
What's fixed

@codecov
Copy link

codecov bot commented Jun 7, 2023 •
edited

Codecov Report

Merging #669 (ecf5e08) into master (e97fb35) will decrease coverage by 9.84%.
The diff coverage is 41.53%.

❗ Current head ecf5e08 differs from pull request most recent head 29ffd7b. Consider uploading reports for the commit 29ffd7b to get more accurate results

@@            Coverage Diff             @@
##           master     #669      +/-   ##
==========================================
- Coverage   82.88%   73.04%   -9.84%     
==========================================
  Files          25       26       +1     
  Lines         222      282      +60     
  Branches       53       73      +20     
==========================================
+ Hits          184      206      +22     
- Misses         31       69      +38     
  Partials        7        7
Impacted Files Coverage Δ
packages/changelog/src/customConfig.ts 100.00% <ø> (ø)
packages/changelog/src/finalizeContext/index.ts 8.57% <8.57%> (ø)
packages/changelog/src/transformer/index.ts 52.00% <54.54%> (-0.50%) ⬇️
packages/changelog/src/handleWriterOpts.ts 96.15% <93.75%> (-3.85%) ⬇️
...kages/changelog/src/transformer/typeDisplayName.ts 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@canisminor1990 canisminor1990 changed the title ✨ feat(changelog): add some configs ✨ feat(changelog): add style configs Jun 7, 2023
@arvinxx arvinxx merged commit f9e6585 into arvinxx:master Jun 10, 2023
1 check passed
github-actions bot pushed a commit that referenced this pull request Jun 10, 2023
@semantic-release-bot
🔖 chore(release): conventional-changelog-gitmoji-config@1.5.0 [skip ci]
e003035 
# conventional-changelog-gitmoji-config [1.5.0](https://github.com/arvinxx/gitmoji-commit-workflow/compare/conventional-changelog-gitmoji-config@1.4.7...conventional-changelog-gitmoji-config@1.5.0) (2023-06-10)

### ✨ Features

* **changelog**: Add changelog style configs, closes [#669](#669) ([f9e6585](f9e6585))
@github-actions
Copy link

🎉 This PR is included in version 1.5.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

github-actions bot pushed a commit that referenced this pull request Jun 10, 2023
@semantic-release-bot
🔖 chore(release): semantic-release-config-gitmoji@1.5.1 [skip ci]
06647bf 
## [1.5.1](https://github.com/arvinxx/gitmoji-commit-workflow/compare/semantic-release-config-gitmoji@1.5.0...semantic-release-config-gitmoji@1.5.1) (2023-06-10)

### ✨ Features

* **changelog**: Add changelog style configs, closes [#669](#669) ([f9e6585](f9e6585))
@github-actions
Copy link

🎉 This PR is included in version 1.5.1 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
2 participants
@canisminor1990 @arvinxx