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: update snapshot release message #1867

Merged
merged 1 commit into from
Jan 24, 2025

Conversation

tatomyr
Copy link
Contributor

@tatomyr tatomyr commented Jan 24, 2025

What/Why/How?

  • Updated the snapshot release message to make comment in the release PR instead of modifying the description.
  • Updated benchmarks.

Reference

Testing

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
Contributor

Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 990.6 ± 23.1 953.8 1037.3 1.01 ± 0.03
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 977.1 ± 20.1 951.4 1008.6 1.00

Copy link
Contributor

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 1ca5083

@tatomyr tatomyr requested a review from a team January 24, 2025 09:03
@tatomyr tatomyr marked this pull request as ready for review January 24, 2025 09:03
@tatomyr tatomyr requested a review from a team as a code owner January 24, 2025 09:03
Comment on lines +39 to +48
COMMENT="📦 A new experimental version **v$VERSION** of Redocly CLI has been published for testing.

Experimental release **v$VERSION**. Install it with \`npm install @redocly/cli@$VERSION\`."
Install with NPM:
\`\`\`bash
npm install @redocly/cli@$VERSION
# or
npm install @redocly/openapi-core@$VERSION
\`\`\`

gh pr edit $PR_NUMBER --body "$NEW_DESCRIPTION"
⚠️ Note: This is a development build and may contain unstable features."
Copy link
Contributor Author

@tatomyr tatomyr Jan 24, 2025

Choose a reason for hiding this comment

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

@Redocly/technical-writers just wanted to clarify the wording if you please.

This will produce the following message:

📦 A new experimental version v0.0.0-snapshot.1737627998 of Redocly CLI has been published for testing.
Install with NPM:

          npm install @redocly/[email protected]
          # or
          npm install @redocly/[email protected]

⚠️ Note: This is a development build and may contain unstable features.

@Marshevskyy Marshevskyy merged commit 9ff3159 into main Jan 24, 2025
44 checks passed
@Marshevskyy Marshevskyy deleted the chore/update-snapshot-release-message branch January 24, 2025 12:02
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.

3 participants