Skip to content

chore: update snapshot release message #1867

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
Marshevskyy merged 1 commit into from
Jan 24, 2025
Merged

chore: update snapshot release message #1867

Show file tree
Hide file tree
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
14 changes: 11 additions & 3 deletions .github/workflows/snapshot-release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,19 @@ jobs:
jq ".version = \"$VERSION\"" packages/cli/package.json > tmp.json && mv tmp.json packages/cli/package.json
jq ".dependencies[\"@redocly/openapi-core\"] = \"$VERSION\"" packages/cli/package.json > tmp.json && mv tmp.json packages/cli/package.json

NEW_DESCRIPTION="${{ github.event.pull_request.body }}
# Add comment with installation instructions
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."
Comment on lines +39 to +48
Copy link
Collaborator Author

@tatomyr tatomyr Jan 24, 2025 •
edited
Loading

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/cli@0.0.0-snapshot.1737627998
          # or
          npm install @redocly/openapi-core@0.0.0-snapshot.1737627998

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


gh pr comment $PR_NUMBER --body "$COMMENT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ github.event.pull_request.number }}
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ Create a new branch from **main**, then find the hash of the commit you want to
Create a patch-level changeset for the revert and open a PR with it.
Merge the PR and cut a release according to the [Release flow](#release-flow).

### Snapshot release flow
### Snapshot release

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

Expand Down
3 changes: 2 additions & 1 deletion benchmark/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@
"cli-1.23": "npm:@redocly/cli@1.23.1",
"cli-1.24": "npm:@redocly/cli@1.24.0",
"cli-1.25": "npm:@redocly/cli@1.25.15",
"cli-1.26": "npm:@redocly/cli@1.26.0",
"cli-1.26": "npm:@redocly/cli@1.26.1",
"cli-1.27": "npm:@redocly/cli@1.27.2",
"cli-next": "file:../redocly-cli.tgz"
}
}
Loading