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

generated changelog.md doesn't pass linting #84

Closed
amclin opened this issue Mar 24, 2020 · 2 comments
Closed

generated changelog.md doesn't pass linting #84

amclin opened this issue Mar 24, 2020 · 2 comments
Labels

Comments

@amclin
Copy link

amclin commented Mar 24, 2020

remark-lint reports several styling issues with the markdown generated by @semantic-release/changelog

Examples:

            8:3  warning  Incorrect list-item indent: add 2 spaces  list-item-indent            remark-lint
      8:13-8:23  warning  Use the trailing `[]` on reference links  no-shortcut-reference-link  remark-lint
      8:13-8:23  warning  Found reference to undefined definition   no-undefined-references     remark-lint
            9:3  warning  Incorrect list-item indent: add 2 spaces  list-item-indent            remark-lint
           10:3  warning  Incorrect list-item indent: add 2 spaces  list-item-indent            remark-lint
           17:3  warning  Incorrect list-item indent: add 2 spaces  list-item-indent            remark-lint
           18:3  warning  Incorrect list-item indent: add 2 spaces  list-item-indent            remark-lint

Are there any plans for semantic-release/changelog to conform to an established linting pattern for markdown?

Alternatively, can the syntax be made configurable in some way so consumers can configure linting compliant patterns for their projects? I hate encouraging teams to exclude files from automated checks.

@pvdlg
Copy link
Member

pvdlg commented Mar 27, 2020

The content of the Changelog is generated by https://github.com/semantic-release/release-notes-generator which uses https://github.com/conventional-changelog/conventional-changelog.

I would recommend to open an issue with https://github.com/conventional-changelog/conventional-changelog

You can customize the format of the output by creating your own conventional-changelog preset and configure it with the preset option

@amclin
Copy link
Author

amclin commented Mar 27, 2020

Thanks for the suggestion, I followed up with the conventional-changelog project

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants