Skip to content

doc: update CHANGELOG.md for recent changes#293

Merged
fangfufu merged 1 commit into
masterfrom
dev
May 31, 2026
Merged

doc: update CHANGELOG.md for recent changes#293
fangfufu merged 1 commit into
masterfrom
dev

Conversation

@fangfufu
Copy link
Copy Markdown
Owner

@fangfufu fangfufu commented May 31, 2026

Document recent CI improvements, including CodeQL workflow scan addition, Prettier replacement with yamlfmt/mdformat, pre-commit pr restrictions, and documentation grammar and typo fixes.

Summary by CodeRabbit

  • Chores

    • Enhanced CI/CD workflows with CodeQL security scanning.
    • Updated workflow configurations and formatting standards.
  • Documentation

    • Fixed documentation typos and improved formatting.
    • Updated usage documentation and guidelines.

Document recent CI improvements, including CodeQL workflow scan addition, Prettier replacement with yamlfmt/mdformat, pre-commit pr restrictions, and documentation grammar and typo fixes.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 31, 2026

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 789d5ab9-b2db-4b73-9af9-462f62f885b1

📥 Commits

Reviewing files that changed from the base of the PR and between 520f162 and 7cc5a51.

📒 Files selected for processing (1)
  • CHANGELOG.md

📝 Walkthrough

Walkthrough

CHANGELOG.md's [Unreleased] section is expanded with three new entries: a CodeQL job for GitHub Actions workflows, CI and documentation improvements (formatter changes and pre-commit restrictions), and documentation typo corrections.

Changes

Changelog Updates

Layer / File(s) Summary
Changelog entries for unreleased changes
CHANGELOG.md
The [Unreleased] section documents a new CodeQL scanning job, expanded CI changes (yamlfmt/mdformat adoption, pre-commit branch restriction, README grammar fix), USAGE.md documentation expansion, and documentation typo corrections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • fangfufu/httpdirfs#290: Updates CHANGELOG.md to document the same CI/formatter changes (CodeQL job, pre-commit restriction, yamlfmt/mdformat, build PKG_CONFIG_PATH) that this PR records.
  • fangfufu/httpdirfs#289: Implements the CodeQL workflow job that this PR's changelog entry documents.
  • fangfufu/httpdirfs#288: Contains the USAGE.md overhaul that this PR's changelog references and documents.

Poem

🐰 A changelog hop, so neat and clean,
Recording changes yet unseen,
CodeQL scans and formatters bright,
Pre-commit rules set just right,
Documentation typos take flight! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@fangfufu fangfufu merged commit 26cce59 into master May 31, 2026
12 of 13 checks passed
@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown
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 updates the CHANGELOG.md file under the [Unreleased] section to document recent changes, including CI updates (such as adding a CodeQL scanning job, replacing Prettier with yamlfmt and mdformat, and restricting pre-commit hooks to the master branch) and documentation fixes. There are no review comments, and I have no feedback to provide.

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