Skip to content
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

chore: add snapshot release pipelines #1853

Merged
merged 14 commits into from
Jan 22, 2025

Conversation

tatomyr
Copy link
Contributor

@tatomyr tatomyr commented Jan 21, 2025

What/Why/How?

Added experimental release flow:

To release an experimental version to the NPM registry, follow these steps:

  1. Create a new PR to main.
  2. Add the snapshot label to the PR. This creates a new PR with to the snapshot branch (which is a copy of the main branch).
  3. Merging the second PR triggers release to the NPM registry under the snapshot tag.

The released version can be installed with npm install @redocly/cli@snapshot or using the released version directly.

Reference

Testing

Tested in this PR.

Screenshots (optional)

Check yourself

  • Code changed? - Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests
  • New package installed? - Tested in different environments (browser/node)

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

Copy link

changeset-bot bot commented Jan 21, 2025

⚠️ No Changeset found

Latest commit: 91f11e2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Jan 21, 2025

Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 990.7 ± 30.4 955.0 1057.0 1.01 ± 0.03
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 980.3 ± 12.9 961.7 1008.6 1.00

Copy link
Contributor

github-actions bot commented Jan 21, 2025

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 78.63% 5047/6419
🟡 Branches 67.28% 2056/3056
🟡 Functions 73.13% 833/1139
🟡 Lines 78.92% 4761/6033

Test suite run success

835 tests passing in 120 suites.

Report generated by 🧪jest coverage report action from 91f11e2

@tatomyr tatomyr added the snapshot Create experimental release PR label Jan 21, 2025
@tatomyr tatomyr added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 21, 2025
@tatomyr tatomyr added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 21, 2025
@tatomyr tatomyr added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 21, 2025
@tatomyr tatomyr force-pushed the chore/add-experimental-release-pipelines branch from a5b572e to 0edf685 Compare January 21, 2025 21:20
@tatomyr tatomyr added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 21, 2025
@tatomyr tatomyr added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 21, 2025
@tatomyr tatomyr removed the snapshot Create experimental release PR label Jan 22, 2025
@tatomyr tatomyr removed the snapshot Create experimental release PR label Jan 22, 2025
@tatomyr tatomyr marked this pull request as ready for review January 22, 2025 12:49
@tatomyr tatomyr requested a review from a team as a code owner January 22, 2025 12:49
Copy link
Member

@RomanHotsiy RomanHotsiy left a comment

Choose a reason for hiding this comment

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

Let's rename it to rc or beta

@tatomyr tatomyr added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 22, 2025
@tatomyr
Copy link
Contributor Author

tatomyr commented Jan 22, 2025

Renamed to snapshot as disscussed.

@tatomyr tatomyr added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 22, 2025
@tatomyr tatomyr added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 22, 2025
@tatomyr tatomyr added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 22, 2025
@tatomyr tatomyr changed the title chore: add experimental release pipelines chore: add snapshot release pipelines Jan 22, 2025
@Marshevskyy Marshevskyy merged commit afcdbb4 into main Jan 22, 2025
47 checks passed
@Marshevskyy Marshevskyy deleted the chore/add-experimental-release-pipelines branch January 22, 2025 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
snapshot Create experimental release PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants