Skip to content

Enhance linting script and workflow #117

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

Merged
merged 3 commits into from
Aug 23, 2025
Merged

Enhance linting script and workflow #117

merged 3 commits into from
Aug 23, 2025

Conversation

joshjohanning
Copy link
Owner

@joshjohanning joshjohanning commented Aug 23, 2025

  • Both lint-gh-cli-readme and lint-scripts-readme jobs now save their lint output to result files and upload them as artifacts, making it easier to review linting issues after the workflow runs.
  • A new post-results job is added to aggregate these lint results and post them as a formatted, sticky comment on the pull request, ensuring contributors get immediate feedback on README quality.
  • Read-only permissions for contents are set on lint jobs, and write permissions for pull requests are set on the posting job, following best practices for GitHub Actions security.
  • Numbering each linting issue
  • Adding an emoji classifying each linting issue.

New example:

1. 📝 The file adding-new-file-script.sh is not mentioned in the README.md
2. 🔒 The file adding-new-file-script.sh does not have execution permissions
3. 🐛 The file adding-new-file-script.sh has a bash syntax error
        gh-cli/adding-new-file-script.sh: line 31: unexpected EOF while looking for matching ``'

❌ Found 3 issues that need to be addressed.

Copy link

github-actions bot commented Aug 23, 2025

📋 README Lint Results

⚡ gh-cli/README.md

✅ No issues found.

🔧 scripts/README.md

✅ No issues found.

Lint results updated at Sat Aug 23 13:53:53 UTC 2025

@joshjohanning joshjohanning force-pushed the update-workflow branch 3 times, most recently from 9e0c533 to 92c7675 Compare August 23, 2025 13:27
@joshjohanning joshjohanning force-pushed the update-workflow branch 4 times, most recently from bc85ba9 to 511b92b Compare August 23, 2025 13:51
- improved error handling
- a running count for each issue
- adding emojis for each type of syntax issue
@joshjohanning joshjohanning changed the title Enhance linting Actions workflow Enhance linting script and workflow Aug 23, 2025
@joshjohanning joshjohanning merged commit d76bedc into main Aug 23, 2025
7 checks passed
@joshjohanning joshjohanning deleted the update-workflow branch August 23, 2025 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant