Skip to content

[2.14]: QA: Fix markdown lint errors#139

Merged
Slamdunk merged 2 commits intolaminas:2.14.xfrom
glensc:md-fix
Mar 15, 2021
Merged

[2.14]: QA: Fix markdown lint errors#139
Slamdunk merged 2 commits intolaminas:2.14.xfrom
glensc:md-fix

Conversation

@glensc
Copy link
Copy Markdown
Contributor

@glensc glensc commented Feb 27, 2021

Q A
Documentation no
Bugfix no
BC Break no
New Feature no
RFC no
QA yes

Description

Fix QA job failing on HEAD:

Error: docs/book/message/character-sets.md:12 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
Error: docs/book/transport/smtp-authentication.md:162:88 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
Error: docs/book/transport/smtp-authentication.md:184:87 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

@glensc
Copy link
Copy Markdown
Contributor Author

glensc commented Feb 27, 2021

How?

  1. brew install markdownlint-cli
  2. wget https://github.com/laminas/laminas-continuous-integration-container/raw/1.2.x/markdownlint.json
  3. markdownlint -c markdownlint.json git ls-ffiles | grep -F .md --fix
  4. fixed docs/book/message/character-sets.md manually

the local markdownlint still complains about COPYRIGHT.md and LICENSE.md, but they probably suppressed in CI (not sure how, but probably not relevant).

➔ markdownlint -c markdownlint.json `g lsf|grep -F .md`
COPYRIGHT.md:1 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "Copyright (c) 2020 Laminas Pro..."]
LICENSE.md:1 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "Copyright (c) 2020 Laminas Pro..."]
[~/scm/php/zend-mail (md-fix)★] ➔

@glensc glensc changed the title Fix markdown lint errors [2.14]: QA: Fix markdown lint errors Feb 27, 2021
@glensc
Apply markdownlint --fix
af7f29b 
Signed-off-by: Elan Ruusamäe <glen@pld-linux.org>
@glensc
Fix non-incremented heading in character-sets.md
3dd1193 
Signed-off-by: Elan Ruusamäe <glen@pld-linux.org>
@Slamdunk Slamdunk merged commit ef83de6 into laminas:2.14.x Mar 15, 2021
@Slamdunk Slamdunk added this to the 2.14.0 milestone Mar 15, 2021
@glensc glensc deleted the md-fix branch March 15, 2021 09:44
@dependabot dependabot Bot mentioned this pull request Mar 18, 2021
Merged
artemii-karkusha pushed a commit to artemii-karkusha/laminas-mail that referenced this pull request May 24, 2023
@Slamdunk
Merge pull request laminas#139 from glensc/md-fix
b003597 
[2.14]: QA: Fix markdown lint errors
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Slamdunk Slamdunk Slamdunk approved these changes

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

2.14.0

Development

Successfully merging this pull request may close these issues.

2 participants

@glensc @Slamdunk