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

Update hallmark requirement from ^3.0.0 to ^3.1.0 #1600

Merged
merged 1 commit into from
Nov 17, 2020

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 16, 2020

Updates the requirements on hallmark to permit the latest version.

Release notes

Sourced from hallmark's releases.

v3.1.0

Added

  • Add bump command to add a new version to changelog (9e2b53b)
    • As an example, hallmark bump minor added this 3.1.0 entry, prepopulated with git commits ✨
    • We now also support hallmark lint and hallmark fix as commands, which going forward are preferred over hallmark and hallmark --fix respectively
  • Export programmatic API (3dc1c87, 6867517, d67f191)
  • Add remark-autolink-references (6e36fda)
    • Transform references like JIRA-123 into links ✨
  • Fallback to git remote to get repository url (dbbe165)
  • Support .hallmarkrc as alternative to package.json (6469e03, fe50723)
    • Hallmark can now be used on non-node projects ✨
Changelog

Sourced from hallmark's changelog.

[3.1.0] - 2020-11-14

Added

  • Add bump command to add a new version to changelog (9e2b53b)
    • As an example, hallmark bump minor added this 3.1.0 entry, prepopulated with git commits ✨
    • We now also support hallmark lint and hallmark fix as commands, which going forward are preferred over hallmark and hallmark --fix respectively
  • Export programmatic API (3dc1c87, 6867517, d67f191)
  • Add remark-autolink-references (6e36fda)
    • Transform references like JIRA-123 into links ✨
  • Fallback to git remote to get repository url (dbbe165)
  • Support .hallmarkrc as alternative to package.json (6469e03, fe50723)
    • Hallmark can now be used on non-node projects ✨

[3.0.0] - 2020-08-22

Changed

  • Breaking: drop node < 10 and upgrade dependencies (02e7c00). Now silently exits on node < 10. Two dozen remark modules have been upgraded, many with breaking changes though most don't apply here. One thing I've noticed is that text like module@1.0.0 will be converted to a mailto link. Wrap such text in backticks.
  • Breaking: remove depth limit on table of contents (031a6ae)
  • Bump remark-changelog (4868875). Adds experimental git submodule support.

Added

  • Support passing options to remark-changelog (6a3923e).

[2.1.0] - 2020-05-06

Added

  • Add options to specify extra plugins (e43475c)

Fixed

[2.0.0] - 2019-09-06

Changed

  • Skip running on node < 8 (e804671)
  • Upgrade standard devDependency from ^13.0.1 to ^14.0.0 (#35)
  • Upgrade rimraf devDependency from ^2.6.3 to ^3.0.0 (#34)

Added

... (truncated)

Commits

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Updates the requirements on [hallmark](https://github.com/vweevers/hallmark) to permit the latest version.
- [Release notes](https://github.com/vweevers/hallmark/releases)
- [Changelog](https://github.com/vweevers/hallmark/blob/master/CHANGELOG.md)
- [Commits](vweevers/hallmark@v3.0.0...v3.1.0)

Signed-off-by: dependabot[bot] <support@github.com>
@feross feross merged commit 5937e95 into master Nov 17, 2020
@feross feross deleted the dependabot/npm_and_yarn/hallmark-tw-3.1.0 branch November 17, 2020 05:07
@feross
Copy link
Member

feross commented Nov 17, 2020

@vweevers I forgot that it was possible to use hallmark to generate the changelog -- we're currently only using it on the AUTHORS.md file. I'd like to use it on the changelog too. If you have a free second, would you mind sending a PR to show us the optimal configuration of that?

@vweevers
Copy link
Contributor

vweevers commented Nov 17, 2020

@feross How would you like to handle headings? Atm hallmark rejects headings other than Changed, Added, Deprecated, Removed, Fixed, Security. The standard changelog has New features, Changed features, New rules, Changed rules.

@feross
Copy link
Member

feross commented Nov 17, 2020

New features -> Added
Changed features -> Changed
Changed rules -> Removed

Unclear what to do with New rules. Maybe it should be merged with the New features in the Added section? However, I kind of like the separation of features and rules.

Is it possible to have extra suffixes on the headings? E.g. Added (features) and Added (rules). Open to ideas.

@vweevers
Copy link
Contributor

Subheadings are allowed (hallmark doesn't lint the content below the 3rd-level headings) so how about:

### Added

- Support the `.gitignore` ignore syntax from the command line

#### New rules

- Require let or const instead of var

@feross
Copy link
Member

feross commented Nov 18, 2020

Oh that would work!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants