Skip to content

ci: allow for prerelease to propagate from full-release action #1426

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.

Sign up for GitHub

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

Merged
joker23 merged 1 commit into from
Jun 16, 2026
+7 −2
Merged

ci: allow for prerelease to propagate from full-release action #1426

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions actions/full-release/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ inputs:
aws_assume_role:
description: 'The ARN of an AWS IAM role to assume. Used to auth with AWS to upload results to S3.'
required: true
prerelease:
description: 'Is this a prerelease. If so, then the latest tag will not be updated in npm. Defaults to `false`.'
required: false
default: 'false'

runs:
using: composite
Expand All @@ -32,8 +36,9 @@ runs:
with:
workspace_name: ${{ env.WORKSPACE_NAME }}
workspace_path: ${{ inputs.workspace_path }}
prerelease: false
prerelease: ${{ inputs.prerelease }}
dry_run: false
- uses: ./actions/publish-docs
- if: ${{ inputs.prerelease != 'true' }}

@joker23 joker23 Jun 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I am a bit iffy about this one. On one hand, I think it makes sense to hold docs until v1, but on the other, it would be nice to have doc links while we work on official docs.

An alternative here is to introduce different stages of release (something like experimental, prerelease, and production) where experimental stage will not have published docs.

@kinyoklion kinyoklion Jun 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We still have the workflow for publishing docs specifically. So if we want to selectively publish docs we could use that.

Alternatively we could have a "Publish docs for pre-release" checkbox.

Generally speaking I do think it is better to default to not publishing the docs for a pre-release.

Eventually we may want to switch to having versioned docs and just /latest would be used in the actual docs. Then these pre-releases could be prefixed and not typically updates /latest

uses: ./actions/publish-docs
with:
workspace_path: ${{ inputs.workspace_path }}
Loading