feat: configure cloudflare worker to redirect to v1 docs if not root #366
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Mark Phelps <[email protected]>
- Add working-directory to Deploy Worker Preview step - Specify wrangler.jsonc config file explicitly - Add preview environment configuration to wrangler.jsonc This fixes the failing test workflow by ensuring wrangler runs from the correct directory with the proper configuration. Signed-off-by: Mark Phelps <[email protected]>
- Enable preview_urls in wrangler configuration - Remove invalid --out json flag from wrangler deploy - Extract preview URL from wrangler deploy console output - Update redirect tests to check for non-redirect status codes instead of expecting 200 (since there's no backend to proxy to) The worker now properly deploys to a preview environment and tests verify that redirects work as expected. Signed-off-by: Mark Phelps <[email protected]>
The /dev/tty device doesn't exist in GitHub Actions environment. Using echo instead to display the output. Signed-off-by: Mark Phelps <[email protected]>
- Add Node.js setup step - Install npm dependencies in worker directory - Use npx to run local wrangler instead of global This ensures all required dependencies are available for the worker deployment. Signed-off-by: Mark Phelps <[email protected]>
Moved preview_urls configuration into the preview environment section to resolve wrangler warnings about missing environment and preview_urls configuration. Signed-off-by: Mark Phelps <[email protected]>
- Add error capture and reporting for wrangler deploy - Add debug step to verify environment and files - Don't immediately exit on error to capture output This will help diagnose why the deployment is failing in CI. Signed-off-by: Mark Phelps <[email protected]>
Now that the API token permissions are fixed, removing the debug output and error handling code that was added for troubleshooting. Signed-off-by: Mark Phelps <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR configures a Cloudflare Worker to automatically redirect legacy documentation URLs to versioned paths, ensuring backward compatibility for existing links while supporting our new versioned documentation structure (v1 and v2).
Changes
Worker Implementation
worker/src/index.tsto handle four distinct cases:/) → redirects to/v2//v1/*,/v2/*) → proxy through without redirect.css,.js,/api/, etc.) → proxy through without redirect/v1/*(legacy compatibility)test/index.spec.ts,test/env.d.ts,test/tsconfig.json)CI/CD Pipeline
.github/workflows/worker.yml) to test worker redirects on every PRConfiguration
wrangler.jsoncto include:docs-preview)Testing
The workflow automatically:
/v2//v1/equivalentsRequirements
CLOUDFLARE_API_TOKENandCLOUDFLARE_ACCOUNT_IDImpact
This ensures that: