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.

Sign up for GitHub

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

Jump to bottom

specs: fix spec markdown linting #3061

Merged
merged 4 commits into from Aug 3, 2022
Merged

specs: fix spec markdown linting #3061

merged 4 commits into from Aug 3, 2022

Conversation

protolambda
Copy link
Contributor

The previous spec markdown had several undetected issues:

  • CI wasn't enforcing Table Of Contents correctness like the old specs repo
  • CI was silencing dead-link errors
  • Running the markdown linter locally was a pain

This PR:

  • Introduces doctoc and markdownlint-cli2 into the monorepo devDependencies for spec linting
  • Updates the CI to use the yarn script jobs
  • Updates CI to not silence the links linting result
  • Fixes typos, lint errors, TOC, outdated links in the spec

@changeset-bot
Copy link

changeset-bot bot commented Jul 17, 2022 •
edited

⚠️ No Changeset found

Latest commit: beeb65e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@protolambda protolambda requested a review from norswap July 17, 2022 02:23
@protolambda protolambda force-pushed the lint-spec-md branch 3 times, most recently from 0d02fd1 to fae2fc9 Compare July 17, 2022 02:33
@protolambda
Copy link
Contributor Author

Won't merge this until I can get some feedback how to install the linting dependencies without affecting CI and the yarn/lerna setup negatively.

@mergify
Copy link
Contributor

mergify bot commented Jul 17, 2022

Hey @protolambda! This PR has merge conflicts. Please fix them before continuing review.

@mergify mergify bot added the conflict label Jul 17, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2022

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@github-actions github-actions bot added the Stale label Aug 2, 2022
@protolambda
style(specs): fix toc/lint in specs, update CI
76c0397 
style(specs): lint/toc/link fixes

style(readme): fix bedrock contracts link

chore(specs): specs lint scripts

chore(specs): update CI jobs to use new lint scripts and unsilence links linter

style(specs): fix toc, fix quotes in markdown lint script
@mergify mergify bot removed the conflict label Aug 2, 2022
@protolambda
Copy link
Contributor Author

update: Fixed broken links, missing batcher spec, and misc lint issues.

@mergify
Copy link
Contributor

mergify bot commented Aug 3, 2022

This PR has been added to the merge queue, and will be merged soon.

@mergify
Copy link
Contributor

mergify bot commented Aug 3, 2022

This PR is next in line to be merged, and will be merged as soon as checks pass.

@mergify mergify bot merged commit b1cc033 into develop Aug 3, 2022
@mergify mergify bot deleted the lint-spec-md branch August 3, 2022 19:32
@mergify mergify bot removed the on-merge-train label Aug 3, 2022
@mslipper mslipper mentioned this pull request Aug 4, 2022
Merged
roninjin10 pushed a commit that referenced this pull request Aug 26, 2022
@protolambda @mergify
specs: fix spec markdown linting (#3061)
429b051 
* style(specs): fix toc/lint in specs, update CI

style(specs): lint/toc/link fixes

style(readme): fix bedrock contracts link

chore(specs): specs lint scripts

chore(specs): update CI jobs to use new lint scripts and unsilence links linter

style(specs): fix toc, fix quotes in markdown lint script

* yarn: update linting dependencies

* specs: add minimal batch submitter spec, fix broken links

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
maurelian pushed a commit that referenced this pull request Sep 15, 2022
@protolambda @mergify @maurelian
specs: fix spec markdown linting (#3061)
fd53f07 
* style(specs): fix toc/lint in specs, update CI

style(specs): lint/toc/link fixes

style(readme): fix bedrock contracts link

chore(specs): specs lint scripts

chore(specs): update CI jobs to use new lint scripts and unsilence links linter

style(specs): fix toc, fix quotes in markdown lint script

* yarn: update linting dependencies

* specs: add minimal batch submitter spec, fix broken links

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
sam-goldman pushed a commit that referenced this pull request Sep 15, 2022
@protolambda @mergify @sam-goldman
specs: fix spec markdown linting (#3061)
8e5cbbf 
* style(specs): fix toc/lint in specs, update CI

style(specs): lint/toc/link fixes

style(readme): fix bedrock contracts link

chore(specs): specs lint scripts

chore(specs): update CI jobs to use new lint scripts and unsilence links linter

style(specs): fix toc, fix quotes in markdown lint script

* yarn: update linting dependencies

* specs: add minimal batch submitter spec, fix broken links

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mslipper mslipper mslipper approved these changes

@maurelian maurelian maurelian approved these changes

@norswap norswap Awaiting requested review from norswap

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@protolambda @mslipper @maurelian