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

checks: exclude README.md from markdown-lint in pre-commit-config.yaml #2971

Merged
merged 3 commits into from
May 20, 2023

Conversation

neteler
Copy link
Member

@neteler neteler commented May 18, 2023

markdown-lint: exclude README.md from 033-no-inline-html.md, i.e. allow inline HTML in README.md.

Addresses
#2947 (comment)

markdown-lint: exclude README.md from 033-no-inline-html.md, i.e. allow inline HTML in README.md.

Addresses
OSGeo#2947 (comment)
@petrasovaa
Copy link
Contributor

If this fixes the README, why exclude it?

Copy link
Contributor

@nilason nilason left a comment

Choose a reason for hiding this comment

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

With the suggested changes the Markdown is valid and no need to exclude the file from validation.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
.pre-commit-config.yaml Outdated Show resolved Hide resolved
Co-authored-by: Nicklas Larsson <n_larsson@yahoo.com>
@neteler
Copy link
Member Author

neteler commented May 18, 2023

If this fixes the README, why exclude it?

It didn't, that's why.
But @nilason came up with a better solution which I have merged into this PR.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Nicklas Larsson <n_larsson@yahoo.com>
@neteler
Copy link
Member Author

neteler commented May 18, 2023

Thanks @nilason, now it looks good.

@neteler
Copy link
Member Author

neteler commented May 19, 2023

(It may be merged as soon as the DNS DOS on osgeo.org stops and the CI comes back to life - or we implement a fallback sample data download using the fatra server)

@neteler neteler merged commit 8ae8d07 into OSGeo:main May 20, 2023
@neteler neteler deleted the markdown-lint_033-no-inline-html branch May 20, 2023 12:18
neteler added a commit that referenced this pull request May 20, 2023
* pre-commit-config.yaml: exclude README.md from markdown-lint

markdown-lint: exclude README.md from 033-no-inline-html.md, i.e. allow inline HTML in README.md.

Addresses
#2947 (comment)

Co-authored-by: Nicklas Larsson <n_larsson@yahoo.com>
@neteler neteler added this to the 8.3.0 milestone May 20, 2023
@wenzeslaus
Copy link
Member

wenzeslaus commented May 23, 2023

Seeing this and other commits on 8.3 branch, there is no need to include file names or even paths in the commit message (and especially in its first line as a prefix). These things are part of the commit itself as the general submitting guidelines discuss. While not automatically enforced, we do have a list prefixes for commit messages in utils/release.yml.

When the known prefixes are used, things like version: are excluded from the release announcements automatically.

Oh, wait, now I see that the file in the commit message was not even changed by the commit... 😭

neteler added a commit to nilason/grass that referenced this pull request Nov 7, 2023
)

* pre-commit-config.yaml: exclude README.md from markdown-lint

markdown-lint: exclude README.md from 033-no-inline-html.md, i.e. allow inline HTML in README.md.

Addresses
OSGeo#2947 (comment)

Co-authored-by: Nicklas Larsson <n_larsson@yahoo.com>
@neteler neteler changed the title pre-commit-config.yaml: exclude README.md from markdown-lint checks: exclude README.md from markdown-lint in pre-commit-config.yaml Jun 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants