Skip to content

Conversation

coliff
Copy link
Member

@coliff coliff commented Sep 11, 2025

Removed 'New' badge from h1-require and main-require rule docs. Updated GitHub Actions usage docs to use latest actions/checkout@v5 and actions/setup-node@v5, and set persist-credentials to false.

Removed 'New' badge from h1-require and main-require rule docs. Updated GitHub Actions usage docs to use latest actions/checkout@v5 and actions/setup-node@v5, and set persist-credentials to false.
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates documentation by removing "New" badges from established rules and modernizing GitHub Actions configuration examples. The changes reflect that h1-require and main-require rules are no longer new features, and update the recommended GitHub Actions versions in documentation.

  • Removed "New" badge from h1-require and main-require rule documentation
  • Updated GitHub Actions example to use actions/checkout@v5 and actions/setup-node@v5 with persist-credentials: false
  • Added additional funding options to the GitHub funding configuration

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
website/src/content/docs/rules/h1-require.mdx Removed "New" badge from rule frontmatter
website/src/content/docs/rules/main-require.mdx Removed "New" badge from rule frontmatter
website/src/content/docs/usage/github-code-scanning.mdx Updated GitHub Actions versions and added persist-credentials configuration
.github/FUNDING.yml Added ko_fi and github funding options

@coliff coliff enabled auto-merge (squash) September 11, 2025 05:14
Copy link

Deploying htmlhint with  Cloudflare Pages  Cloudflare Pages

Latest commit: f310b27
Status: ✅  Deploy successful!
Preview URL: https://4de2495d.htmlhint.pages.dev
Branch Preview URL: https://dev-coliff-improve-gh-action.htmlhint.pages.dev

View logs

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request primarily involves documentation updates. It removes the 'New' badge from the h1-require and main-require rule pages, which is a standard maintenance task. It also updates the GitHub Actions usage example to use the latest major versions of actions/checkout (v5) and actions/setup-node (v5), and adds persist-credentials: false which is a security best practice. These changes are correct and improve the quality of the documentation.

While reviewing the github-code-scanning.mdx file, I noticed a potential issue in the example workflow that is outside the scope of the current changes. The command npx htmlhint . --format sarif || true will print the SARIF report to standard output instead of a file. The subsequent Upload SARIF file step will then likely fail because it expects the file at website/htmlhint.sarif. To make the example work as intended, the command should probably be updated to npx htmlhint . --format sarif --output website/htmlhint.sarif || true. This is just a suggestion for a future improvement to make the documentation example more robust for users.

@coliff coliff disabled auto-merge September 11, 2025 05:15
@coliff coliff merged commit 5a5b8c1 into main Sep 11, 2025
13 of 18 checks passed
@coliff coliff deleted the dev/coliff/improve-gh-action-example branch September 11, 2025 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant