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

doc: format markdown files in test directory #40290

Merged
merged 1 commit into from
Oct 5, 2021
Merged

doc: format markdown files in test directory #40290

merged 1 commit into from
Oct 5, 2021

Conversation

Trott
Copy link
Member

@Trott Trott commented Oct 3, 2021

Use make format-md to format markdown files in test directory.

@nodejs-github-bot nodejs-github-bot added async_hooks Issues and PRs related to the async hooks subsystem. needs-ci PRs that need a full CI run. test Issues and PRs related to the tests. labels Oct 3, 2021
@Trott Trott removed the needs-ci PRs that need a full CI run. label Oct 3, 2021
@tniessen
Copy link
Member

tniessen commented Oct 3, 2021

@Trott could this potentially be covered by linters so that we don't need to manually format it every once in a while?

tniessen
tniessen approved these changes Oct 3, 2021
View reviewed changes
Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

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

LGTM either way

@Trott
Copy link
Member Author

Trott commented Oct 3, 2021

@Trott could this potentially be covered by linters so that we don't need to manually format it every once in a while?

Possibly. Right now, we can't autoformat because it would break the README.md format depended on by node-core-utils and possibly other things. (I had tried to get ahead of that but got too far ahead of it....) And there are a lot of these kinds of fixes in doc. But once those are done, we could possibly change the lint step to format first. The main problem would be when it introduces a line-too-long problem due to formatting, similar to the way that can happen with JS linting.

@Trott Trott added the fast-track PRs that do not need to wait for 48 hours to land. label Oct 3, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2021

Fast-track has been requested by @Trott. Please 👍 to approve.

@jasnell jasnell added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 3, 2021
@Trott Trott added commit-queue Add this label to land a pull request using GitHub Actions. and removed fast-track PRs that do not need to wait for 48 hours to land. labels Oct 5, 2021
@github-actions github-actions bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Oct 5, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2021

Commit Queue failed
- Loading data for nodejs/node/pull/40290
✔  Done loading data for nodejs/node/pull/40290
----------------------------------- PR info ------------------------------------
Title      doc: format markdown files in test directory (#40290)
Author     Rich Trott  (@Trott)
Branch     Trott:test-format -> nodejs:master
Labels     test, async_hooks, author ready
Commits    1
 - doc: format markdown files in test directory
Committers 1
 - Rich Trott 
PR-URL: https://github.com/nodejs/node/pull/40290
Reviewed-By: Michaël Zasso 
Reviewed-By: Zijian Liu 
Reviewed-By: Daijiro Wachi 
Reviewed-By: Tobias Nießen 
Reviewed-By: James M Snell 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/40290
Reviewed-By: Michaël Zasso 
Reviewed-By: Zijian Liu 
Reviewed-By: Daijiro Wachi 
Reviewed-By: Tobias Nießen 
Reviewed-By: James M Snell 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sun, 03 Oct 2021 01:48:26 GMT
   ✔  Approvals: 5
   ✔  - Michaël Zasso (@targos) (TSC): https://github.com/nodejs/node/pull/40290#pullrequestreview-769557341
   ✔  - Zijian Liu (@Lxxyx): https://github.com/nodejs/node/pull/40290#pullrequestreview-769561820
   ✔  - Daijiro Wachi (@watilde): https://github.com/nodejs/node/pull/40290#pullrequestreview-769564399
   ✔  - Tobias Nießen (@tniessen) (TSC): https://github.com/nodejs/node/pull/40290#pullrequestreview-769580958
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/40290#pullrequestreview-769596533
   ✔  Last GitHub Actions successful
   ✖  No Jenkins CI runs detected
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/1306219419

@Trott
doc: format markdown files in test directory
cbd61c9 
Use `make format-md` to format markdown files in `test` directory.

PR-URL: nodejs#40290
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
@Trott
Copy link
Member Author

Trott commented Oct 5, 2021

Landed in cbd61c9

@Trott Trott merged commit cbd61c9 into nodejs:master Oct 5, 2021
@Trott Trott deleted the test-format branch October 5, 2021 03:19
danielleadams pushed a commit that referenced this pull request Oct 5, 2021
@Trott @danielleadams
doc: format markdown files in test directory
88bdbf1 
Use `make format-md` to format markdown files in `test` directory.

PR-URL: #40290
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
@danielleadams danielleadams mentioned this pull request Oct 5, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lxxyx Lxxyx Lxxyx approved these changes

@tniessen tniessen tniessen approved these changes

@targos targos targos approved these changes

@watilde watilde watilde approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
async_hooks Issues and PRs related to the async hooks subsystem. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-failed An error occurred while landing this pull request using GitHub Actions. test Issues and PRs related to the tests.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@Trott @tniessen @jasnell @watilde @targos @Lxxyx @nodejs-github-bot