ci: allow for prerelease to propagate from full-release action#1426
Conversation
|
@launchdarkly/js-sdk-common size report |
|
@launchdarkly/browser size report |
|
@launchdarkly/js-client-sdk-common size report |
|
@launchdarkly/js-client-sdk size report |
| prerelease: ${{ inputs.prerelease }} | ||
| dry_run: false | ||
| - uses: ./actions/publish-docs | ||
| - if: ${{ inputs.prerelease != 'true' }} |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
583a296 to
9a47be5
Compare
This PR should make it easier to do pre-releases without updating the
latesttag in NPM by letting us propagate theprereleaseinput from thefull-releaseaction down to thepublishaction.Note
Low Risk
CI workflow wiring only; default behavior unchanged when
prereleaseis omitted.Overview
Adds an optional
prereleaseinput to thefull-releasecomposite action (defaultfalse) and forwards it topublishinstead of always passingfalse, so callers can run pre-releases without moving npm’slatesttag.When
prereleaseistrue, thepublish-docsstep is skipped so documentation is not published for pre-releases.Reviewed by Cursor Bugbot for commit 9a47be5. Bugbot is set up for automated code reviews on this repo. Configure here.