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

Prevent creation of .md-e files in the docs #3799

Merged
merged 1 commit into from
Feb 15, 2024
Merged

Prevent creation of .md-e files in the docs #3799

merged 1 commit into from
Feb 15, 2024

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Feb 15, 2024

Description

Currently the pre-commit lint step uses sed to ensure that we do not use ```console in the documentation and instead replace it with ```bash.

The sed command works for Linux but is interpreted differently on macOS where -i -e is interpreted as -i='-e' and causes .md-e files to to be created for every documentation file when linting using just lint. Using perl can avoid this problem as that approach is cross-platform (provided perl is installed, which is usually is).

This also updates another script that used a similar construct in a different script (with the working and broken operating systems reversed) with perl.

Testing Instructions

  1. Check that lint step in CI passes.
  2. Intentionally change some occurrences of ```bash to ```console in the docs.
  3. See that pre-commit does not allow you to commit these mistakes.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb requested review from a team as code owners February 15, 2024 05:56
@dhruvkb dhruvkb added 🟨 priority: medium Not blocking but should be addressed soon 💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: mgmt Related to repo management and automations labels Feb 15, 2024
Copy link
Collaborator

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

LGTM! Worried we might be playing whack-a-mole switching between various tools presumed to be installed and behave the same across platforms, but perl sounds like a good next choice. Hopefully it continues to work 😁

@dhruvkb dhruvkb merged commit 653d968 into main Feb 15, 2024
72 checks passed
@dhruvkb dhruvkb deleted the fix_mde_files branch February 15, 2024 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: mgmt Related to repo management and automations
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants