CI workflow paths指定する

r-sugi commented 2 months ago

PR Type

enhancement, configuration changes

Description

Updated workflow configurations by renaming workflows and jobs for consistency.
Removed unnecessary steps from the lint workflow.
Added a new workflow for unit testing, triggered on pull requests and pushes to the main branch.

Changes walkthrough 📝

Relevant files

Configuration changes

lint.yml `Update lint workflow configuration and job naming` .github/workflows/lint.yml Renamed workflow from `Lint_Test` to `Lint`. Changed job name from `lint_ut` to `Run-Lint`. Removed unit test step from the lint workflow.	+4/-7
review.yml `Modify review workflow configuration and job naming` .github/workflows/review.yml Renamed workflow from `Agent Review` to `Agent-Review`. Changed job name from `run-pr-agent` to `Run-PR-Agent`. Removed `reopened` type from pull request trigger.	+5/-3
storybook.yml `Revise storybook workflow configuration and job naming` .github/workflows/storybook.yml Renamed workflow from `build-storybook` to `Build-Storybook`. Changed job name from `build-storybook` to `Run-Build`. Updated pull request paths trigger.	+5/-4

Enhancement

unit-test.yml

Add new unit test workflow configuration

.github/workflows/unit-test.yml

Added new workflow for unit testing.

Configured to run on pull requests and pushes to main.

Includes steps for checking out code, setting up Node.js, and running
tests.

+25/-0

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nextjs-tdd-template_storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 10, 2024 2:18am

github-actions[bot] commented 2 months ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ No key issues to review

github-actions[bot] commented 2 months ago

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	`node-version`の指定を具体的なバージョンに変更する。 ___ `node-version`の指定が"^v18.19.0"となっていますが、互換性の問題を避けるために具体的なバージョンを指定することをお勧めします。 [.github/workflows/unit-test.yml [19]](https://github.com/r-sugi/nextjs-tdd-template/pull/187/files#diff-d4223b44df678cece85f2542c19b9cd060d43b22f753c25214d5942ef2ca5d18R19-R19) ```diff -node-version: "^v18.19.0" +node-version: "18.19.0" ``` Suggestion importance[1-10]: 9 Why: Specifying an exact `node-version` helps avoid potential compatibility issues that can arise from using a range, ensuring a more stable and predictable environment for running tests.	9
Enhancement	`types`の指定に`reopened`を追加する。 ___ `types`の指定から`reopened`が削除されていますが、再オープンされたプルリクエストに対する処理が必要な場合は、`reopened`を追加することをお勧めします。 [.github/workflows/review.yml [5]](https://github.com/r-sugi/nextjs-tdd-template/pull/187/files#diff-ebc21ccd816b27c07389e15ad88c9e74b71bde5e8e315e4e30902097d38386e5R5-R5) ```diff -types: [opened, synchronize] +types: [opened, reopened, synchronize] ``` Suggestion importance[1-10]: 8 Why: Adding `reopened` to the `types` specification ensures that the workflow runs for pull requests that are reopened, which is important for maintaining consistent review processes.	8
	`branches`の指定に`dev`ブランチを追加する。 ___ `branches`の指定に`main`のみを含めると、他のブランチでの変更が無視される可能性があります。`dev`ブランチも含めることを検討してください。 [.github/workflows/lint.yml [7]](https://github.com/r-sugi/nextjs-tdd-template/pull/187/files#diff-107e910e9f2ebfb9a741fa10b2aa7100cc1fc4f5f3aca2dfe78b905cbd73c0d2R7-R7) ```diff -branches: [main] +branches: [main, dev] ``` Suggestion importance[1-10]: 7 Why: Including the `dev` branch in the `branches` specification can be beneficial for ensuring that changes in the development branch are also linted, which can help catch issues earlier in the development process.	7
	`paths`の指定をより具体的にする。 ___ `paths`の指定がありますが、``を使用しているため、特定のファイルやディレクトリに限定されていない可能性があります。より具体的なパス指定を検討してください。 [.github/workflows/storybook.yml [5]](https://github.com/r-sugi/nextjs-tdd-template/pull/187/files#diff-97cca8fb169bc3951469886bf2f73b7bcc362a6b6da11325c7a617f69a797248R5-R5) ```diff -paths: [src/, .storybook/, package.json, package-lock.json, mocks/] +paths: [src/components/, .storybook/config/, package.json, package-lock.json, mocks/data/**] ``` Suggestion importance[1-10]: 6 Why: Making the `paths` specification more specific can help optimize the workflow by only triggering it for relevant changes, although the current specification is already functional.	6

r-sugi / nextjs-tdd-template