Skip to content

fix(Felt): track docs @patternfly alias versions via the workspace protocol - #12706

Merged
gabipodolnikova merged 1 commit into
patternfly:felt-v1from
gabipodolnikova:fix-docs-alias-workspace-tracking
Nov 2, 2026
Merged

gabipodolnikova merged 1 commit into
patternfly:felt-v1from
gabipodolnikova:fix-docs-alias-workspace-tracking

Conversation

@gabipodolnikova

Copy link
Copy Markdown
Contributor

What: Follow-up to #12705 — makes the docs @patternfly/* aliases immune to release version bumps, so the YN0028 CI breakage can't recur.

Additional issues: Follow-up to #12699 / #12705 (PF-4694)

Background

#12705 fixed the failing Release workflow by bumping three stale alias pins, but the root cause remains: the aliases pin exact versions, which must match the workspace versions for yarn to link them to the local packages. Every release of an aliased package re-creates the drift — and release commits are [ci skip], so the breakage is invisible until the next CI run fails with YN0028.

The fix

Replace the exact pins with workspace ranges:

- "@patternfly/react-core": "npm:@rh-felt/react-core@0.0.1-prerelease.4",
+ "@patternfly/react-core": "npm:@rh-felt/react-core@workspace:^",

The npm:<name>@workspace:^ form binds each alias to the local workspace regardless of its current version, so releases no longer require lockstep pin bumps. (Correction to a note in #12705: yarn 4 does support aliasing to workspaces — npm:<name>@workspace:<range> is the working syntax; the workspace:<name> form tried there is the one yarn rejects.)

The @patternfly/patternfly → @rh-felt/styles alias keeps its registry pin because @rh-felt/styles is not a workspace in this repo; a stale pin there only lags the published CSS package and cannot break --immutable installs.

The aliases themselves remain temporary scaffolding until the Felt-compatible documentation framework lands (PF-4694 follow-up) — this just makes them maintenance-free in the meantime.

Verification

  • yarn install --immutable passes (the invocation CI uses)
  • All six aliases symlink to packages/*; lockfile descriptors merge the alias and workspace entries
  • Simulated a release: bumped react-core to an unpublished 0.0.1-prerelease.5 — the aliases stayed linked to the workspace, resolved the new version with zero manifest edits, and --immutable still passed (the exact scenario that broke felt-v1 on Oct 30)
  • yarn build and yarn build:docs pass

…otocol

Replace the exact-version pins on the six @patternfly/* npm aliases in
react-docs with workspace ranges:

    "@patternfly/react-core": "npm:@rh-felt/react-core@workspace:^"

The exact pins had to match the workspace versions for yarn to link
the aliases to the local packages, so every release of an aliased
package silently broke `yarn install --immutable` (YN0028) until the
pins were bumped in lockstep (patternfly#12705). The `npm:<name>@workspace:^`
form binds each alias to the local workspace regardless of its
current version, so releases no longer require pin bumps.

The @patternfly/patternfly -> @rh-felt/styles alias keeps its registry
pin because styles is not a workspace in this repo; a stale pin there
only lags the published CSS package and cannot break installs.

Verified: yarn install --immutable passes; a simulated version bump
to an unpublished 0.0.1-prerelease.5 keeps every alias linked to its
workspace with no manifest changes; yarn build and yarn build:docs
pass.
@coderabbitai

coderabbitai Bot commented Nov 2, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 4a4df01f-2c53-447c-a732-9386bb7f2ce9

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

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@gabipodolnikova
gabipodolnikova merged commit 25ee617 into patternfly:felt-v1 Nov 2, 2026
15 checks passed
@patternfly-build

Copy link
Copy Markdown
Collaborator

Your changes have been released in:

  • @rh-felt/react-charts@0.0.1-prerelease.4
  • @rh-felt/react-code-editor@0.0.1-prerelease.5
  • @rh-felt/react-core@0.0.1-prerelease.5
  • @rh-felt/react-docs@0.0.1-prerelease.3
  • @rh-felt/react-drag-drop@0.0.1-prerelease.5
  • @rh-felt/react-icons@0.0.1-prerelease.3
  • @rh-felt/react-integration@6.5.0-prerelease.26
  • demo-app-ts@6.5.0-prerelease.142
  • @rh-felt/react-styles@0.0.1-prerelease.4
  • @rh-felt/react-table@0.0.1-prerelease.5
  • @rh-felt/react-templates@0.0.1-prerelease.5
  • @rh-felt/react-tokens@0.0.1-prerelease.3

Thanks for your contribution! 🎉

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.

2 participants