Skip to content

Draft: Document Alias Preview URLs #22578

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

Draft
wants to merge 1 commit into
base: production
Choose a base branch
from

Conversation

WillTaylorDev
Copy link
Contributor

Summary

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions github-actions bot added product:workers Related to Workers product size/s labels May 20, 2025
Copy link
Contributor

hyperlint-ai bot commented May 20, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Documented the new Alias Preview URLs feature for Workers, enhancing the existing preview URL documentation.

  • Introduced the concept of Alias Preview URLs, allowing users to assign human-readable aliases to Worker versions.
  • Updated the documentation to include details on creating and managing Alias Preview URLs.
  • Clarified the differences between Version-Prefixed and Alias Preview URLs.

Modified Files

  • src/content/docs/workers/configuration/multipart-upload-metadata.mdx
  • src/content/docs/workers/configuration/previews.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

Copy link
Contributor

github-actions bot commented May 20, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @WalshyDev, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing, @ToriLindsay, @cloudflare/wrangler
/src/content/docs/workers/wrangler/ @cloudflare/wrangler, @irvinebroque, @ToriLindsay, @cloudflare/pcx-technical-writing

@WillTaylorDev WillTaylorDev force-pushed the willtaylor/alias-preview-urls branch from 346f87a to b0c2561 Compare May 20, 2025 16:28
@@ -1462,6 +1462,8 @@ wrangler versions upload [OPTIONS]
- Add a version tag. Accepts empty string.
- `--message` <Type text="string" /> <MetaInfo text="optional" />
- Add a version message. Accepts empty string.
- `--alias` <Type text="string" /> <MetaInfo text="optional" />
Copy link
Contributor

Choose a reason for hiding this comment

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

Possible conflict with --alias, the bundle flag for aliasing modules?


1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/?to=/:account/workers) and select your project.
2. Go to the **Deployments** tab, and find the version you would like to view.

### Aliased Preview URLs

Aliased preview URLs let you assign a persistent, readable alias to a specific Worker version. These are useful for linking to stable previews across environments. These types of preview URLs follow the same pattern as other preview URLs:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Aliased preview URLs let you assign a persistent, readable alias to a specific Worker version. These are useful for linking to stable previews across environments. These types of preview URLs follow the same pattern as other preview URLs:
Aliased preview URLs let you assign a persistent, readable alias to a specific Worker version. These are useful for linking to stable previews across many versions. These types of preview URLs follow the same pattern as other preview URLs:

I'm vetoing the word "environment" 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:workers Related to Workers product size/s
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants