Closed cheton closed 2 months ago
Open the branch in Web Editor • VS Code • Insiders
Open Preview
Latest commit: 6e11be1493d85dfcfae7d4be311c7d800f6617d3
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.
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
⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪ |
🧪 No relevant tests |
🔒 No security concerns identified |
⚡ Key issues to review **Configuration Consistency:** Ensure that the changes in the GitHub Actions workflow and `package.json` scripts are consistent and correctly integrate with the existing CI/CD pipeline. **Dependency Management:** The addition of `@changesets/cli` and `@changesets/changelog-github` should be reviewed to ensure they are compatible with other dependencies and correctly configured. |
Category | Suggestion | Score |
Performance |
Add a cache step for yarn dependencies to speed up workflow runs___ **Consider adding acache step for yarn dependencies to speed up the workflow runs and reduce the load on the package registry.** [.github/workflows/changesets-release.yml [31-33]](https://github.com/trendmicro-frontend/tonic-ui/pull/884/files#diff-dab56b8e025a5098264c80c3e4da18714a7c63c3f88ad320c52e12cf9b3c9185R31-R33) ```diff +- name: Cache Yarn Dependencies + uses: actions/cache@v2 + with: + path: | + ~/.yarn/cache + node_modules + key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} + restore-keys: | + ${{ runner.os }}-yarn- - name: Install Dependencies id: install-dependencies run: yarn install ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 8Why: Adding a cache step for yarn dependencies is a significant improvement for performance, reducing build times and network load. | 8 |
Best practice |
Ensure the full git history is available by setting
___
**Add a | 7 |
Add a
___
**Add a | 7 | |
Enhancement |
Add a post-publish step to notify a Slack channel about the new release___ **Add apost-publish step to notify a Slack channel or other communication tool about the new release.** [.github/workflows/changesets-release.yml [35-44]](https://github.com/trendmicro-frontend/tonic-ui/pull/884/files#diff-dab56b8e025a5098264c80c3e4da18714a7c63c3f88ad320c52e12cf9b3c9185R35-R44) ```diff - name: Create Release Pull Request or Publish to npm id: changesets uses: changesets/action@master with: title: "chore(release): version packages" commit: "chore(release): version packages [skip ci]" publish: yarn ci-publish version: yarn changeset version env: GITHUB_TOKEN: ${{ env.GITHUB_TOKEN }} NPM_TOKEN: ${{ env.NPM_TOKEN }} +- name: Notify Slack + if: success() + uses: 8398a7/action-slack@v3 + with: + status: ${{ job.status }} + fields: repo,message,commit,author,action,eventName,ref,workflow,job,took + env: + SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 6Why: Adding a notification step enhances the communication and awareness of new releases, although it's more of an enhancement than a critical improvement. | 6 |
This pull request is automatically built and testable in CodeSandbox.
To see build info of the built libraries, click here or the icon next to each commit SHA.
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 74.83%. Comparing base (
7baee21
) to head (6e11be1
).
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
/review
Reference
PR Type
Enhancement, Configuration changes
Description
package.json
to include Changesets dependencies and scripts for publishing, and modified existing publish scripts to include build steps.Changes walkthrough 📝
README.md
Add README for Changesets with documentation links
.changeset/README.md
links to documentation.
config.json
Add Changesets configuration file
.changeset/config.json
repository details.
changesets-release.yml
Add GitHub Actions workflow for Changesets release
.github/workflows/changesets-release.yml
package.json
Update package.json with Changesets dependencies and scripts
package.json