Skip to content

Conversation

@jathavaan
Copy link
Collaborator

No description provided.

@jathavaan jathavaan self-assigned this Sep 30, 2025
Copilot AI review requested due to automatic review settings September 30, 2025 12:18
@jathavaan jathavaan merged commit cc99495 into main Sep 30, 2025
2 of 3 checks passed
@jathavaan jathavaan deleted the feature/5-workflow-for-publishing-docs branch September 30, 2025 12:18
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a GitHub Actions workflow for publishing documentation to GitHub Pages with versioned releases. The workflow is triggered on version tags and allows manual dispatch for publishing schema documentation.

  • Adds a new workflow for publishing docs with proper permissions and version handling
  • Updates documentation deployment to use cp instead of rsync for better compatibility
  • Creates a landing page with automatic redirect to the main schema documentation

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
.github/workflows/publish-docs.yml New workflow for publishing versioned docs to GitHub Pages with permissions and deployment configuration
.github/workflows/deploy-schema-gh-pages.yml Adds automatic redirect landing page creation for better user experience

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

VERSION=${GITHUB_REF_NAME} # e.g. v0.0.1
mkdir -p site/$VERSION
generate-schema-doc schema/ site/$VERSION/ \
generate-schema-doc schema/ site/$VERSION \
Copy link

Copilot AI Sep 30, 2025

Choose a reason for hiding this comment

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

Removing the trailing slash from the destination path may cause generate-schema-doc to create files differently than expected. The original site/$VERSION/ indicates the destination should be treated as a directory, while site/$VERSION could be interpreted as a file. This could lead to incorrect file placement or generation errors.

Suggested change
generate-schema-doc schema/ site/$VERSION \
generate-schema-doc schema/ site/$VERSION/ \

Copilot uses AI. Check for mistakes.
--config with_footer=false

# Create a landing page that redirects to schema.html (or whichever file you want as entry)
echo '<meta http-equiv="refresh" content="0; url=schema.html">' > _site/index.html
Copy link

Copilot AI Sep 30, 2025

Choose a reason for hiding this comment

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

The meta refresh redirect is vulnerable to open redirect attacks if the URL parameter can be manipulated. Consider using a more secure redirect method or validating that the target URL is safe and internal to the site.

Copilot uses AI. Check for mistakes.
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.

1 participant