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 make targets #196

Merged
merged 3 commits into from
Jan 15, 2025
Merged

add markdownlint make targets #196

merged 3 commits into from
Jan 15, 2025

Conversation

obnoxxx
Copy link
Collaborator

@obnoxxx obnoxxx commented Jan 14, 2025

Describe what this PR does

This PR adds make targets markdownlintand markdownlint-fix to allow developers to conveniently run markdownlint locally.

The lintci workflow is changed to use the make target instead of the github action.

Is there anything that requires special attention

This PR is based on and depends on PR #195

Is the change backward compatible?

yes

Are there concerns around backward compatibility?

no

Related issues

Fixes: #159

Future concerns

none
Checklist:

  • Commit Message Formatting: Commit titles and messages follow
    guidelines in the developer
    guide
    .
  • Reviewed the developer guide on Submitting a Pull
    Request
  • Pending release
    notes

    updated with breaking and/or notable changes for the next major release.
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.

@obnoxxx obnoxxx force-pushed the markdownlint branch 3 times, most recently from c3b571b to 3f4abf4 Compare January 14, 2025 15:25
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@obnoxxx obnoxxx force-pushed the markdownlint branch 3 times, most recently from 244732a to ec344ef Compare January 15, 2025 09:08
@obnoxxx obnoxxx requested a review from Madhu-1 January 15, 2025 09:11
Copy link
Collaborator

@Madhu-1 Madhu-1 left a comment

Choose a reason for hiding this comment

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

CI job is not running, can you please check?

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@obnoxxx obnoxxx force-pushed the markdownlint branch 2 times, most recently from 99e9ef2 to 7bc6bc1 Compare January 15, 2025 09:33
@obnoxxx obnoxxx requested a review from Madhu-1 January 15, 2025 09:34
@Madhu-1
Copy link
Collaborator

Madhu-1 commented Jan 15, 2025

This is so that markdownlint can conveniently  be run locally
in developer environments.

Signed-off-by: Michael Adam <[email protected]>
Also fixed a lint error in an issue template

Signed-off-by: Michael Adam <[email protected]>
@Madhu-1 Madhu-1 merged commit e5044db into ceph:main Jan 15, 2025
13 checks passed
@obnoxxx obnoxxx deleted the markdownlint branch January 15, 2025 13:35
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 a makefile target for markdown linter check
2 participants