Bor dev tech patch 1 #41
Conversation
This script manages lint issues by creating or updating GitHub issues based on lint results and the directory tree output. It generates issue titles and bodies, checks for existing issues, and closes issues for files no longer present in the directory.
| # Step 4: Install and run the tree command for directory mapping | ||
| - name: Generate Repository File Tree (Exclude node_modules) | ||
| id: tree | ||
| run: | | ||
| apt-get update && apt-get install -y tree | ||
| tree -L 5 -I "node_modules" > tree-output.txt |
There was a problem hiding this comment.
The apt-get commands are being run without sudo privileges. In GitHub Actions ubuntu-latest runners, these commands require elevated permissions. This will cause the workflow to fail with a permission denied error.
| # Step 4: Install and run the tree command for directory mapping | |
| - name: Generate Repository File Tree (Exclude node_modules) | |
| id: tree | |
| run: | | |
| apt-get update && apt-get install -y tree | |
| tree -L 5 -I "node_modules" > tree-output.txt | |
| # Step 4: Install and run the tree command for directory mapping | |
| - name: Generate Repository File Tree (Exclude node_modules) | |
| id: tree | |
| run: | | |
| sudo apt-get update && sudo apt-get install -y tree | |
| tree -L 5 -I "node_modules" > tree-output.txt |
| - name: Run Linter and Export Results | ||
| id: lint | ||
| working-directory: ./Application | ||
| run: | | ||
| npm run lint --json > lint-output.json |
There was a problem hiding this comment.
The npm run lint command has an incorrect output redirection syntax. The --json flag should come before the redirection operator, and the command may fail depending on the linter's exit code. The syntax should be 'npm run lint -- --format=json > lint-output.json' or similar depending on the linter being used. Additionally, if lint errors are found, npm run lint typically exits with a non-zero code which will fail the workflow step unless you add '|| true' to allow continuation.
| - name: Run Linter and Export Results | |
| id: lint | |
| working-directory: ./Application | |
| run: | | |
| npm run lint --json > lint-output.json | |
| - name: Run Linter and Export Results | |
| id: lint | |
| working-directory: ./Application | |
| run: | | |
| npm run lint -- --format=json > lint-output.json || true |
| for (let result of lintResults) { | ||
| const filePath = result.filePath.replace('Application/', ''); | ||
| const lintMessage = result.message; | ||
| const ruleId = result.ruleId; | ||
|
|
||
| if (!treeOutput.includes(filePath)) { | ||
| continue; // Skip if file not in the directory tree | ||
| } | ||
|
|
||
| const issueTitle = generateIssueTitle(filePath); | ||
| const issueBody = `**File:** ${filePath}\n**Error:** ${lintMessage}\n**Rule ID:** ${ruleId}`; | ||
| const labels = ['Lint Detection']; | ||
|
|
||
| if (existingIssuesMap.has(issueTitle)) { | ||
| const existingIssue = existingIssuesMap.get(issueTitle); | ||
| const updatedBody = existingIssue.body.includes(lintMessage) | ||
| ? existingIssue.body | ||
| : `${existingIssue.body}\n\n**Additional Issue:** ${lintMessage}`; | ||
|
|
||
| if (updatedBody !== existingIssue.body) { | ||
| await octokit.issues.update({ | ||
| owner: REPO_OWNER, | ||
| repo: REPO_NAME, | ||
| issue_number: existingIssue.number, | ||
| body: updatedBody, | ||
| }); | ||
| } | ||
| } else { | ||
| await octokit.issues.create({ | ||
| owner: REPO_OWNER, | ||
| repo: REPO_NAME, | ||
| title: issueTitle, | ||
| body: issueBody, | ||
| labels, | ||
| }); | ||
| } |
There was a problem hiding this comment.
The GitHub API calls inside the loop are not rate-limited or batched, which could hit GitHub API rate limits when processing many lint errors. Consider batching updates or adding delay between API calls to avoid rate limiting issues, especially in repositories with many lint errors.
| # Step 4: Install and run the tree command for directory mapping | ||
| - name: Generate Repository File Tree (Exclude node_modules) | ||
| id: tree | ||
| run: | | ||
| apt-get update && apt-get install -y tree | ||
| tree -L 5 -I "node_modules" > tree-output.txt | ||
|
|
||
| # Step 5: Run the issue management script using the lint output and tree file | ||
| - name: Process and Manage GitHub Issues for Lint | ||
| run: | | ||
| node scripts/manageLintIssues.js ./Application/lint-output.json tree-output.txt | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
There was a problem hiding this comment.
The workflow is missing installation of the @octokit/rest package which is required by the manageLintIssues.js script. The script requires this dependency but it's only installed in the Application directory. Either add a package.json in the root directory with this dependency, or install it explicitly before running the script.
| # Step 4: Install and run the tree command for directory mapping | |
| - name: Generate Repository File Tree (Exclude node_modules) | |
| id: tree | |
| run: | | |
| apt-get update && apt-get install -y tree | |
| tree -L 5 -I "node_modules" > tree-output.txt | |
| # Step 5: Run the issue management script using the lint output and tree file | |
| - name: Process and Manage GitHub Issues for Lint | |
| run: | | |
| node scripts/manageLintIssues.js ./Application/lint-output.json tree-output.txt | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| # Step 4: Install and run the tree command for directory mapping | |
| - name: Generate Repository File Tree (Exclude node_modules) | |
| id: tree | |
| run: | | |
| apt-get update && apt-get install -y tree | |
| tree -L 5 -I "node_modules" > tree-output.txt | |
| # Step 5: Install Octokit dependency required by manageLintIssues.js | |
| - name: Install Octokit dependency | |
| run: npm install @octokit/rest | |
| # Step 6: Run the issue management script using the lint output and tree file | |
| - name: Process and Manage GitHub Issues for Lint | |
| run: | | |
| node scripts/manageLintIssues.js ./Application/lint-output.json tree-output.txt | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
1 participant
This pull request introduces an automated workflow for lint detection and issue management, integrating GitHub Actions and a custom Node.js script. The main goal is to ensure that code lint errors are automatically detected and tracked as GitHub issues, with real-time updates based on the current state of the repository.
Workflow and automation enhancements:
.github/workflows/lint-detection.ymlto automate lint checks on pull requests and pushes tomaster, run the linter, generate a file tree, and invoke an issue management script for lint errors.Lint issue management logic:
scripts/manageLintIssues.jsto parse lint results and directory tree, create or update GitHub issues for each lint error, and close issues for files removed from the repository.