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

Could the title rule be loosened or ignored ? #18

Open
jrfnl opened this issue Apr 17, 2022 · 6 comments
Open

Could the title rule be loosened or ignored ? #18

jrfnl opened this issue Apr 17, 2022 · 6 comments

Comments

@jrfnl
Copy link

jrfnl commented Apr 17, 2022

Given a changelog with the following title:

# Changelog for Project ABC

I'm receiving the following warning:

CHANGELOG.md
     1:1-1:47  warning  Changelog must start with a top-level "Changelog" heading          title                    remark-changelog

Question

I'd like to keep the title as it is as it is more descriptive than just "Changelog" and clearly links the changelog to the project it belongs with.

Unfortunately I haven't been able to figure out how to do this.

  1. Is there a way to silence the title warning ?
    I tried setting title to false, but that didn't work:
    {
      "plugins": [
        ["remark-changelog",
          {
            "repository": "https://github.com/org/repo",
            "title": false
          }
        ]
      ]
    }
  2. Should the title check just check that the H1 title starts with "Changelog" instead of is "Changelog" ?

Note: I'm not very experienced with Node/Node configs, so it may well be that I'm just doing something wrong.
I would just really like to add this check to various (non-JS) projects as I find it important that Changelogs are consistent and comply with Keep A Changelog. (so thank you for making this ruleset!)

@vweevers
Copy link
Owner

There is no such option, and I'm hesistant to add one. There should be one CHANGELOG.md per repository/project, which makes it obvious for which project it is.

@jrfnl
Copy link
Author

jrfnl commented Apr 17, 2022

Well, it would be a shame not to be able to use this checker, just because the title doesn't comply.

Having an option (as described in option 1) to ignore individual rules if so desired by the project would help in that regards.

@vweevers
Copy link
Owner

Being flexible about rules is not a goal here. This is a tool to enforce a style guide.

@jrfnl
Copy link
Author

jrfnl commented Apr 17, 2022

I understand and appreciate that, believe me when I say that I really like what you've done here. But it makes adoption a lot harder if people can't incrementally improve something, so having some flexibility is IMO a good thing.

@vweevers
Copy link
Owner

I don't yet see why this would be an improvement. Can you explain your use case? Do you have e.g. multiple changelogs per repository? Or are the changelogs grouped together in another location (e.g. some website that isn't GitHub, where you're listing multiple changelogs)?

@jrfnl
Copy link
Author

jrfnl commented Apr 17, 2022

Just as an example: think a mono-repo where each package in the repo has its own changelog.

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

No branches or pull requests

2 participants