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

Enforce that all docs have last_review_date frontmatter #19264

Merged
merged 1 commit into from
Feb 8, 2025

Conversation

issyl0
Copy link
Member

@issyl0 issyl0 commented Feb 8, 2025

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

@issyl0
Copy link
Member Author

issyl0 commented Feb 8, 2025

homebrew/docs on  lint-frontmatter-presence [$!?] via 💎 v3.3.7 
❯ git diff
diff --git a/docs/Adding-Software-to-Homebrew.md b/docs/Adding-Software-to-Homebrew.md
index 694c0b24aa..b54c020686 100644
--- a/docs/Adding-Software-to-Homebrew.md
+++ b/docs/Adding-Software-to-Homebrew.md
@@ -1,7 +1,3 @@
----
-last_review_date: "1970-01-01"
----
-
 # Adding Software to Homebrew
 
 Is your favourite software missing from Homebrew? Then you're the perfect person to resolve this problem.
homebrew/docs on  lint-frontmatter-presence [$!?] via 💎 v3.3.7 
❯ bundle exec rake lint
mdl $(git ls-files '*.md' | grep -v 'Manpage.md')
grep -L '^last_review_date:' $(git ls-files '*.md' | grep -v 'Manpage.md') | xargs -I {} echo 'File {} is missing last_review_date frontmatter.'
File Adding-Software-to-Homebrew.md is missing last_review_date frontmatter.

- So we don't forget to add it to new docs we write.
@issyl0 issyl0 force-pushed the lint-frontmatter-presence branch from cd7954a to 00905fb Compare February 8, 2025 00:14
Copy link
Member

@p-linnane p-linnane left a comment

Choose a reason for hiding this comment

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

Great idea! Thanks!

@issyl0 issyl0 added this pull request to the merge queue Feb 8, 2025
Merged via the queue into master with commit a0be99a Feb 8, 2025
28 checks passed
@issyl0 issyl0 deleted the lint-frontmatter-presence branch February 8, 2025 08:41
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.

2 participants