Setup PR Previews for Storybook Documentation with Timestamp and Enhanced Troubleshooting

[codegen-sh]

This PR sets up PR previews for the Storybook documentation in the lambda-curry/forms repository using GitHub's native Pages deployment workflow with proper environment protection.

Changes:

1. Created a new GitHub workflow (pr-preview.yml) that:

   • Builds the Storybook documentation for each PR
   • Uploads the build as an artifact
   • Deploys a preview to GitHub Pages using the native GitHub Pages actions
   • Adds a comment to the PR with a link to the preview and a timestamp
   • Automatically redeploys when changes are pushed to the PR
   • Cleans up the preview when the PR is closed

2. Updated the main GitHub Pages workflow to ensure it doesn't remove PR previews when deploying the main branch

3. Updated the README with detailed information about the PR preview feature and environment setup

Latest Updates:

• Added a timestamp to the PR comment to show when the preview was last updated
• Added the direct URL in code format for easy copying
• Improved troubleshooting steps in the README with detailed instructions
• Enhanced the PR comment with more detailed information

Important Setup Required:

For this to work properly, you need to create a GitHub environment:

1. Go to your repository settings
2. Navigate to "Environments"
3. Create a new environment named pr-preview
4. Configure environment protection rules as needed (e.g., require approvals)

How it works:

When a PR is created or updated, the workflow will:

1. Build the Storybook documentation
2. Verify the build output contains an index.html file
3. Upload the build as an artifact
4. Deploy it to a PR-specific directory on the gh-pages branch
5. Add a comment to the PR with a link to the preview and a timestamp showing when it was last updated

When a PR is closed, the workflow will:

1. Checkout the gh-pages branch
2. Remove the PR-specific directory
3. Commit and push the changes

Preview URLs will follow this format:

https://lambda-curry.github.io/forms/pr-preview/pr-[PR_NUMBER]/

This approach uses GitHub's native Pages deployment workflow instead of third-party actions, making it more reliable and maintainable.

[bolt-new-by-stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

PR Preview Action v1.6.0
🚀 View preview at https://https://lambda-curry.github.io/forms/pr-preview/pr-42/
Built to branch gh-pages at 2025-03-21 03:11 UTC. Preview will be ready when the GitHub Pages deployment is complete.

[github-actions]

📝 Storybook Preview: View Storybook

This preview will be updated automatically when you push new changes to this PR.

Note: The preview will be available after the workflow completes and the PR is approved for deployment.