Skip to content

chore: Add GitHub Actions workflow file for enforcing metadata in docs#2099

Merged
crazyuploader merged 14 commits intomainfrom
chore/add-github-metadata-checker
Oct 29, 2025
Merged

chore: Add GitHub Actions workflow file for enforcing metadata in docs#2099
crazyuploader merged 14 commits intomainfrom
chore/add-github-metadata-checker

Conversation

@crazyuploader
Copy link
Contributor

@crazyuploader crazyuploader commented Oct 21, 2025

This PR adds support for GitHub Actions check for enforcing metadata in docs such as date, tags, and title.

Closes: #3029, #876

This commit adds support for GitHub Actions check for enforcing metadata
in docs such as date, tags, and title.

Signed-off-by: Jugal Kishore <jugal@signoz.io>
@crazyuploader crazyuploader self-assigned this Oct 21, 2025
@crazyuploader crazyuploader requested a review from a team as a code owner October 21, 2025 10:47
@vercel
Copy link

vercel bot commented Oct 21, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
signoz-web Ready Ready Preview Comment Oct 29, 2025 0:04am

Signed-off-by: Jugal Kishore <jugal@signoz.io>
@github-actions
Copy link
Contributor

github-actions bot commented Oct 21, 2025

📄 Documentation Metadata Validation

Validation Failed

The following documentation files are missing required metadata:

Required Fields

  • tags: [] — Array of tags (e.g., ["SigNoz Cloud", "Self-Host"])
  • date: — Date in YYYY-MM-DD format
  • title: — Non-empty title field

Example

---
title: My Documentation Page
date: 2025-10-29
tags: ["SigNoz Cloud", "Self-Host"]
---

Please add the required metadata to these docs to proceed with this PR.

Signed-off-by: Jugal Kishore <jugal@signoz.io>
Signed-off-by: Jugal Kishore <jugal@signoz.io>
@crazyuploader crazyuploader linked an issue Oct 29, 2025 that may be closed by this pull request
Copy link
Member

@makeavish makeavish left a comment

Choose a reason for hiding this comment

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

Check description as well otherwise LGTM

@makeavish
Copy link
Member

@codex review

@chatgpt-codex-connector
Copy link

Codex Review: Didn't find any major issues. Keep them coming!

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@crazyuploader crazyuploader merged commit ad0a551 into main Oct 29, 2025
4 checks passed
@crazyuploader crazyuploader deleted the chore/add-github-metadata-checker branch October 29, 2025 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update dates for New Docs

3 participants