fix: skip read run dir when it not exists #32
Conversation
WalkthroughThis pull request introduces several changes to the egg-development project, focusing on updating the project's infrastructure, documentation, and dependencies. The modifications include removing the pull request template, updating GitHub Actions workflows, enhancing the changelog, and making minor code adjustments. The changes reflect a modernization effort, dropping support for older Node.js versions and improving the project's continuous integration and development processes. Changes
Sequence DiagramsequenceDiagram
participant Workflow as GitHub Actions
participant Repo as Repository
participant Node as Node.js
participant Package as Package Manager
Workflow->>Repo: Checkout code
Workflow->>Node: Setup Node.js 20
Workflow->>Package: Install dependencies
Workflow->>Package: Build project
Workflow->>Package: Publish package
Poem
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 (
|
commit: |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #32 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 4 4
Lines 64 156 +92
Branches 0 42 +42
=========================================
+ Hits 64 156 +92 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (3)
agent.js (1)
Line range hint
13-16: Consider adding debug logging for skipped cleanup.While the implementation is correct, adding debug logging when skipping directory cleanup could help with troubleshooting.
if (!stat) return; +agent.logger.debug('[agent:development] skip timing cleanup, rundir not exists: %s', rundir); const files = await fs.readdir(rundir);CHANGELOG.md (2)
38-38: Consider expanding the features sectionThe features section could be more detailed to match the auto-generated summary, including the new GitHub Actions workflow and other enhancements.
Consider adding more detailed entries:
### Features * upgrade deps ([#31](https://github.com/eggjs/egg-development/issues/31)) ([af27674](https://github.com/eggjs/egg-development/commit/af27674a60b0407179db65499cf2b4b55662b06b)) + * add new GitHub Actions workflow for Node.js releases + * enhance file system operations using Node.js built-in modules
61-61: Grammar: Capitalize "Windows"When referring to the operating system, "Windows" should be capitalized.
- * [[`b661cad`](http://github.com/eggjs/egg-development/commit/b661cad0251bb580c04ad2b8e7f35b20c765820b)] - fix: incorrect debounce on windows (#28) (hyj1991 <<[email protected]>>) + * [[`b661cad`](http://github.com/eggjs/egg-development/commit/b661cad0251bb580c04ad2b8e7f35b20c765820b)] - fix: incorrect debounce on Windows (#28) (hyj1991 <<[email protected]>>)🧰 Tools
🪛 LanguageTool
[grammar] ~61-~61: “Windows” (operating system by Microsoft) is a proper noun and needs to be capitalized.
Context: ...c765820b)] - fix: incorrect debounce on windows (#28) (hyj1991 <[email protected]...(A_WINDOWS)
🪛 Markdownlint (0.37.0)
61-61: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
.github/PULL_REQUEST_TEMPLATE.md(0 hunks).github/workflows/nodejs.yml(1 hunks).github/workflows/pkg.pr.new.yml(1 hunks)CHANGELOG.md(1 hunks)History.md(0 hunks)README.md(2 hunks)agent.js(1 hunks)app.js(1 hunks)package.json(1 hunks)
💤 Files with no reviewable changes (2)
- .github/PULL_REQUEST_TEMPLATE.md
- History.md
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[grammar] ~61-~61: “Windows” (operating system by Microsoft) is a proper noun and needs to be capitalized.
Context: ...c765820b)] - fix: incorrect debounce on windows (#28) (hyj1991 <[email protected]...
(A_WINDOWS)
🪛 Markdownlint (0.37.0)
CHANGELOG.md
42-42: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
48-48: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
54-54: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
67-67: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
73-73: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
79-79: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
85-85: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
90-90: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
96-96: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
102-102: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
108-108: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
114-114: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
120-120: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
125-125: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
131-131: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
137-137: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
142-142: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
147-147: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
152-152: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
157-157: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
161-161: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
46-46: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
52-52: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
58-58: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
61-61: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
64-64: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
65-65: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
71-71: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
77-77: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
83-83: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
88-88: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
94-94: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
100-100: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
106-106: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
112-112: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
118-118: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
123-123: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
128-128: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
129-129: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
134-134: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
135-135: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
140-140: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
145-145: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
150-150: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
155-155: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
159-159: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
163-163: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
45-45: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
51-51: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
57-57: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
60-60: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
63-63: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
70-70: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
76-76: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
82-82: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
93-93: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
99-99: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
105-105: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
111-111: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
117-117: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
106-106: null
Spaces inside code span elements
(MD038, no-space-in-code)
🔇 Additional comments (5)
agent.js (1)
10-11: LGTM! Robust error handling for non-existent directory.
The implementation correctly uses fs.stat with throwIfNoEntry: false to handle non-existent directories gracefully. This aligns with the PR objective and prevents unnecessary errors when the run directory hasn't been created yet.
package.json (1)
23-23: LGTM! Minor dependency update.
The update to utility ^2.3.0 is a minor version bump and shouldn't affect the main functionality.
README.md (1)
4-4: LGTM! Documentation improvements.
Good improvements to the documentation:
- Updated CI status badge
- Added Node.js version badge
- Simplified license link
- Added contributors section
Also applies to: 8-8, 74-80
CHANGELOG.md (2)
Line range hint 1-8: LGTM! Version bump and breaking changes are well documented.
The changelog correctly indicates the major version bump and clearly states the breaking change of dropping Node.js < 14 support.
🧰 Tools
🪛 LanguageTool
[grammar] ~61-~61: “Windows” (operating system by Microsoft) is a proper noun and needs to be capitalized.
Context: ...c765820b)] - fix: incorrect debounce on windows (#28) (hyj1991 <[email protected]...
(A_WINDOWS)
🪛 Markdownlint (0.37.0)
42-42: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
48-48: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
54-54: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
67-67: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
73-73: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
79-79: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
85-85: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
90-90: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
96-96: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
102-102: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
108-108: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
114-114: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
120-120: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
125-125: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
131-131: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
137-137: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
142-142: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
147-147: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
152-152: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
157-157: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
161-161: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
46-46: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
52-52: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
58-58: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
61-61: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
64-64: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
65-65: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
71-71: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
77-77: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
83-83: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
88-88: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
94-94: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
100-100: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
106-106: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
112-112: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
118-118: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
123-123: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
128-128: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
129-129: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
134-134: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
135-135: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
140-140: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
145-145: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
150-150: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
155-155: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
159-159: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
163-163: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
45-45: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
51-51: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
57-57: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
60-60: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
63-63: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
70-70: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
76-76: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
82-82: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
93-93: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
99-99: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
105-105: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
111-111: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
117-117: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
106-106: null
Spaces inside code span elements
(MD038, no-space-in-code)
42-165: LGTM! Historical entries maintain consistent formatting.
The historical entries follow a consistent formatting style, making the changelog easy to read and navigate.
🧰 Tools
🪛 LanguageTool
[grammar] ~61-~61: “Windows” (operating system by Microsoft) is a proper noun and needs to be capitalized.
Context: ...c765820b)] - fix: incorrect debounce on windows (#28) (hyj1991 <[email protected]...
(A_WINDOWS)
🪛 Markdownlint (0.37.0)
42-42: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
48-48: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
54-54: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
67-67: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
73-73: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
79-79: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
85-85: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
90-90: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
96-96: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
102-102: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
108-108: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
114-114: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
120-120: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
125-125: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
131-131: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
137-137: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
142-142: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
147-147: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
152-152: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
157-157: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
161-161: Expected: atx; Actual: setext
Heading style
(MD003, heading-style)
46-46: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
52-52: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
58-58: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
61-61: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
64-64: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
65-65: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
71-71: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
77-77: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
83-83: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
88-88: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
94-94: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
100-100: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
106-106: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
112-112: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
118-118: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
123-123: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
128-128: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
129-129: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
134-134: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
135-135: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
140-140: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
145-145: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
150-150: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
155-155: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
159-159: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
163-163: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
45-45: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
51-51: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
57-57: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
60-60: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
63-63: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
70-70: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
76-76: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
82-82: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
93-93: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
99-99: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
105-105: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
111-111: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
117-117: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
106-106: null
Spaces inside code span elements
(MD038, no-space-in-code)
| secrets: | ||
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} |
There was a problem hiding this comment.
💡 Codebase verification
CODECOV_TOKEN secret needs to be configured
The CODECOV_TOKEN secret is not configured in the repository settings. This needs to be set up before the workflow can successfully report code coverage to Codecov.
- Go to repository Settings > Secrets and variables > Actions
- Add a new repository secret with name
CODECOV_TOKEN - Get the token value from your Codecov account dashboard
🔗 Analysis chain
Verify CODECOV_TOKEN secret configuration
The addition of CODECOV_TOKEN is good for code coverage reporting. However, please ensure this secret is properly configured in the repository settings.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if CODECOV_TOKEN is configured in repository secrets
gh api repos/:owner/:repo/actions/secrets/CODECOV_TOKEN --jq '.name' 2>/dev/null || echo "Warning: CODECOV_TOKEN secret not found"
Length of output: 315
| build: | ||
| runs-on: ubuntu-latest |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add job conditions to prevent unauthorized publishing
The build job should have conditions to ensure publishing only occurs in appropriate circumstances.
build:
runs-on: ubuntu-latest
+ if: |
+ github.event_name == 'push' &&
+ github.ref == 'refs/heads/master' ||
+ (github.event_name == 'pull_request' &&
+ github.event.pull_request.merged == true)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| build: | |
| runs-on: ubuntu-latest | |
| build: | |
| runs-on: ubuntu-latest | |
| if: | | |
| github.event_name == 'push' && | |
| github.ref == 'refs/heads/master' || | |
| (github.event_name == 'pull_request' && | |
| github.event.pull_request.merged == true) |
| name: Publish Any Commit | ||
| on: [push, pull_request] |
There was a problem hiding this comment.
Security concern: Workflow triggers may be too permissive
Running publish workflow on any push or pull_request could potentially expose sensitive operations to unauthorized contributors. Consider:
- Restricting to specific branches
- Adding conditions for when publishing should occur
-on: [push, pull_request]
+on:
+ push:
+ branches: [ master ]
+ pull_request:
+ branches: [ master ]
+ types: [closed]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| name: Publish Any Commit | |
| on: [push, pull_request] | |
| name: Publish Any Commit | |
| on: | |
| push: | |
| branches: [ master ] | |
| pull_request: | |
| branches: [ master ] | |
| types: [closed] |
| - name: Build | ||
| run: npm run prepublishOnly --if-present | ||
|
|
||
| - run: npx pkg-pr-new publish |
There was a problem hiding this comment.
💡 Codebase verification
Security concern: Authentication is required for package publishing
The pkg-pr-new package requires GitHub token authentication as it uses @octokit/action internally. The current workflow is missing the necessary authentication token setup.
- Add
GITHUB_TOKENto the job's environment:
- run: npx pkg-pr-new publish
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}🔗 Analysis chain
Security concern: Missing authentication for package publishing
The pkg-pr-new publish command likely needs authentication tokens for package publishing. Ensure proper authentication is configured.
Let me gather more information about the authentication setup in the workflow file.
Let me check the package.json and any documentation for pkg-pr-new to understand its authentication requirements.
Let me check if pkg-pr-new is available on npm and examine its documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if NPM_TOKEN is configured in repository secrets
gh api repos/:owner/:repo/actions/secrets/NPM_TOKEN --jq '.name' 2>/dev/null || echo "Warning: NPM_TOKEN secret not found"
Length of output: 303
Script:
#!/bin/bash
# Check the workflow file for any environment variables or authentication setup
cat .github/workflows/pkg.pr.new.yml
# Also check if there are any other workflow files that might be related
fd workflow .github/workflows --exec cat {}
Length of output: 528
Script:
#!/bin/bash
# Check package.json for pkg-pr-new configuration
cat package.json
# Search for any documentation or readme files
fd -e md -e txt -d 1 . --exec cat {}
# Check if pkg-pr-new is installed and examine its package.json
cat node_modules/pkg-pr-new/package.json 2>/dev/null || echo "pkg-pr-new not found in node_modules"
Length of output: 9627
Script:
#!/bin/bash
# Check if pkg-pr-new exists on npm and get its details
npm view pkg-pr-new 2>/dev/null || echo "Package not found on npm"
# Search for any references to pkg-pr-new in the codebase
rg -i "pkg-pr-new" -A 3 -B 3
Length of output: 779
| "utility": "^2.3.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/node": "^22.10.2", |
There was a problem hiding this comment.
Verify @types/node version compatibility.
The specified version ^22.10.2 seems incorrect as Node.js 22 is not released yet. Consider using a version that matches your supported Node.js version (>=14).
- "@types/node": "^22.10.2",
+ "@types/node": "^14.18.0",Committable suggestion skipped: line range outside the PR's diff.
[skip ci] ## [3.0.1](v3.0.0...v3.0.1) (2024-12-22) ### Bug Fixes * skip read run dir when it not exists ([#32](#32)) ([2d24ce3](2d24ce3))
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Chores
Refactor