Skip to content

Conversation

@joshjms
Copy link
Member

@joshjms joshjms commented Mar 25, 2025

Add ETCD_ROOT_DIR="$(git rev-parse --show-toplevel)" in markdown_diff_lint.sh.
Solves #18059

Please read https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.

@k8s-ci-robot
Copy link

Hi @joshjms. Thanks for your PR.

I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@ivanvc
Copy link
Member

ivanvc commented Mar 25, 2025

/retitle markdown lint job: set ETCD_ROOT_DIR to root directory of git repository
/ok-to-test

@k8s-ci-robot k8s-ci-robot changed the title set ETCD_ROOT_DIR to root directory of git repository markdown lint job: set ETCD_ROOT_DIR to root directory of git repository Mar 25, 2025
@joshjms
Copy link
Member Author

joshjms commented Mar 25, 2025

/test pull-etcd-markdown-lint

@joshjms joshjms force-pushed the fix-markdown-lint branch from d37bbad to ee632a1 Compare March 25, 2025 03:33
@joshjms
Copy link
Member Author

joshjms commented Mar 25, 2025

/test pull-etcd-markdown-lint

@joshjms
Copy link
Member Author

joshjms commented Mar 25, 2025

/test pull-etcd-verify

@joshjms
Copy link
Member Author

joshjms commented Mar 25, 2025

@ivanvc The lint works now. I'll rollback the dummy README changes. Other than that, should I fix the existing errors and/or disable certain criteria for the linting (e.g. line length)?

@joshjms joshjms force-pushed the fix-markdown-lint branch from 1b8cb92 to 332a7bb Compare March 25, 2025 03:55
@ivanvc
Copy link
Member

ivanvc commented Mar 25, 2025

@ivanvc The lint works now. I'll rollback the dummy README changes. Other than that, should I fix the existing errors and/or disable certain criteria for the linting (e.g. line length)?

It can be done in a follow-up PR or this one. If you do it in this one, add a new commit that updates the configuration file. Thanks :)

@ivanvc
Copy link
Member

ivanvc commented Mar 25, 2025

Btw, please squash your commits, thanks

@joshjms
Copy link
Member Author

joshjms commented Mar 25, 2025

It can be done in a follow-up PR or this one. If you do it in this one, add a new commit that updates the configuration file. Thanks :)

I think I'll disable the line-length lints in this commit. If there are any other fails, I'll fix the markdown files later in another PR.

@codecov
Copy link

codecov bot commented Mar 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.76%. Comparing base (3b9ee9b) to head (c80e617).
Report is 48 commits behind head on main.

Additional details and impacted files

see 20 files with indirect coverage changes

@@            Coverage Diff             @@
##             main   #19666      +/-   ##
==========================================
- Coverage   68.85%   68.76%   -0.10%     
==========================================
  Files         421      421              
  Lines       35855    35855              
==========================================
- Hits        24689    24656      -33     
- Misses       9737     9769      +32     
- Partials     1429     1430       +1     

Continue to review full report in Codecov by Sentry.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@joshjms
Copy link
Member Author

joshjms commented Mar 25, 2025

@ivanvc I'll fix the error markdown files. I disabled the line length checks (I think we don't want it).

// MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md
// "MD013": {
//   // Number of characters
//   "line_length": 80,
//   // Number of characters for headings
//   "heading_line_length": 80,
//   // Number of characters for code blocks
//   "code_block_line_length": 80,
//   // Include code blocks
//   "code_blocks": true,
//   // Include tables
//   "tables": true,
//   // Include headings
//   "headings": true,
//   // Strict length checking
//   "strict": false,
//   // Stern length checking
//   "stern": false
// },
"MD013": false,

should I remove it entirely or commenting it is ok?

@joshjms
Copy link
Member Author

joshjms commented Mar 25, 2025

/test pull-etcd-markdown-lint

@joshjms joshjms force-pushed the fix-markdown-lint branch from affbe2e to cdd6b5e Compare March 25, 2025 12:20
@joshjms joshjms force-pushed the fix-markdown-lint branch 2 times, most recently from 062ccd9 to fbf63b6 Compare March 25, 2025 12:54
@joshjms joshjms force-pushed the fix-markdown-lint branch from fbf63b6 to 8e5f288 Compare March 25, 2025 13:10
@k8s-ci-robot k8s-ci-robot added github_actions Pull requests that update GitHub Actions code size/M and removed size/XL labels Mar 25, 2025
@joshjms joshjms force-pushed the fix-markdown-lint branch 3 times, most recently from f6199cd to e847494 Compare March 26, 2025 02:06
@joshjms joshjms force-pushed the fix-markdown-lint branch from e847494 to f52c8b9 Compare March 26, 2025 02:08
joshjms added 2 commits March 26, 2025 10:15
Signed-off-by: joshjms <joshjms1607@gmail.com>
Add newline at the end of file

Signed-off-by: joshjms <joshjms1607@gmail.com>
Copy link
Member

@ivanvc ivanvc left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks, @joshjms.

Copy link
Member

@jmhbnz jmhbnz left a comment

Choose a reason for hiding this comment

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

LGTM - Thanks for fixing this @joshjms

@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ivanvc, jmhbnz, joshjms

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jmhbnz jmhbnz merged commit fbaf89b into etcd-io:main Apr 6, 2025
33 checks passed
@joshjms joshjms deleted the fix-markdown-lint branch April 27, 2025 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

4 participants