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

Add markdownlint #2662

Merged
merged 5 commits into from
Feb 12, 2020
Merged

Add markdownlint #2662

merged 5 commits into from
Feb 12, 2020

Conversation

tjanez
Copy link
Member

@tjanez tjanez commented Feb 10, 2020

Closes #2572.

TODO:

  • Use gitlint to lint the Change Log fragments.

@codecov
Copy link

codecov bot commented Feb 10, 2020

Codecov Report

Merging #2662 into master will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2662   +/-   ##
=======================================
  Coverage   63.09%   63.09%           
=======================================
  Files         365      365           
  Lines       34587    34587           
=======================================
+ Hits        21822    21823    +1     
+ Misses      10048    10047    -1     
  Partials     2717     2717           
Impacted Files Coverage Δ
go/worker/common/p2p/p2p.go 67.56% <0.00%> (-6.31%) ⬇️
go/common/grpc/auth/auth.go 88.88% <0.00%> (-5.56%) ⬇️
go/worker/storage/service_external.go 47.19% <0.00%> (-4.50%) ⬇️
go/runtime/tagindexer/tagindexer.go 70.65% <0.00%> (-2.18%) ⬇️
go/storage/api/grpc.go 70.26% <0.00%> (-0.75%) ⬇️
go/worker/compute/merge/committee/node.go 75.75% <0.00%> (-0.50%) ⬇️
go/runtime/transaction/transaction.go 77.10% <0.00%> (ø) ⬆️
go/consensus/tendermint/tendermint.go 67.31% <0.00%> (+0.55%) ⬆️
go/storage/client/client.go 76.52% <0.00%> (+0.86%) ⬆️
go/worker/compute/executor/committee/node.go 62.84% <0.00%> (+1.18%) ⬆️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 933e53e...546dfaf. Read the comment docs.

line-length:
# Line length checking is not strict by default.
strict: true
line_length: 80
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any specific reason for 80?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing in particular, 80 is something I'm most used to.

@tjanez tjanez force-pushed the tjanez/add-markdownlint branch 2 times, most recently from 5836ec2 to 795377e Compare February 11, 2020 12:54
@tjanez tjanez marked this pull request as ready for review February 11, 2020 12:57
@tjanez tjanez force-pushed the tjanez/add-markdownlint branch from 795377e to 005ddb3 Compare February 11, 2020 13:40
Add Lint Markdown files and Lint Change Log fragments steps to ci-lint
GitHub Actions workflow.
It is more familiar to developers and prevents confusion between
requiring a Change Log fragment's subject line to end with period and
requiring a Git commit message's subject line not to end with a period.
@tjanez tjanez force-pushed the tjanez/add-markdownlint branch from 005ddb3 to 546dfaf Compare February 12, 2020 14:06
@tjanez tjanez merged commit 97da2e6 into master Feb 12, 2020
@tjanez tjanez deleted the tjanez/add-markdownlint branch February 12, 2020 14:30
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

Successfully merging this pull request may close these issues.

Add Markdown lint CI step
2 participants