-
Notifications
You must be signed in to change notification settings - Fork 278
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
ci(workflows): add vue-docs test package release script #2824
Conversation
WalkthroughThe pull request introduces modifications to GitHub Actions workflows and CLI release commands. The changes primarily focus on enhancing the publishing process for components and documentation. The workflow files are updated to include additional publishing steps, specifically for site documentation. The CLI release scripts are modified to support site-specific package configuration and improve the visibility of utility functions. Changes
Sequence DiagramsequenceDiagram
participant Workflow as GitHub Actions
participant CLI as Release CLI
participant Site as Site Package
Workflow->>CLI: Trigger release process
CLI->>Site: Modify package.json
CLI->>Workflow: Update version and configuration
Workflow->>Workflow: Publish components
Workflow->>Workflow: Publish site documentation
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
WalkthroughThis pull request introduces a new script for testing package releases in the vue-docs. It modifies existing workflow files and adds a new function to handle site alpha releases, ensuring package dependencies are correctly managed. Changes
|
[e2e-test-warn] The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug". Please make sure you've read our contributing guide |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.github/workflows/dispatch-all-publish-alpha.yml
(1 hunks).github/workflows/dispatch-renderless-theme-publish-alpha.yml
(3 hunks)internals/cli/src/commands/release/releaseAlpha.ts
(2 hunks)internals/cli/src/commands/release/releaseE2EConfig.ts
(1 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
internals/cli/src/commands/release/releaseAlpha.ts
[error] 65-66: Avoid the delete operator which can impact performance.
Unsafe fix: Use an undefined assignment instead.
(lint/performance/noDelete)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: PR Unit Test
- GitHub Check: build
🔇 Additional comments (5)
internals/cli/src/commands/release/releaseE2EConfig.ts (1)
4-4
: LGTM! Good refactoring to enable code reuse.The export of
pathFromExamples
improves modularity by allowing its reuse in the newreleaseSiteAlpha
function.internals/cli/src/commands/release/releaseAlpha.ts (1)
70-70
: LGTM! Good integration of site release.The integration of
releaseSiteAlpha
in the release process ensures consistent package naming and versioning for the site package..github/workflows/dispatch-all-publish-alpha.yml (1)
89-89
: LGTM! Good sequencing of publish commands.The site publishing is correctly sequenced after all components are published, using the same authentication token.
.github/workflows/dispatch-renderless-theme-publish-alpha.yml (2)
10-10
: LGTM! Good update to include docs module.The input description and validation logic are correctly updated to include the docs module.
Also applies to: 29-29
92-97
: LGTM! Well-structured docs publishing step.The docs publishing step is:
- Correctly conditioned on docs module selection
- Uses the same authentication token as other publish steps
PR
添加vue-docs测试包发布脚本
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
New Features
Chores
The changes improve the release and publishing mechanisms with more comprehensive support for documentation and site-related tasks.