Google Style Guide bundle - #1
Merged
Merged
Conversation
WalkthroughThe change adds MCP and agent configuration, CodeRabbit review automation, repository metadata, licensing, and CI validation for OKF bundles and shell scripts. ChangesProject tooling and validation
Estimated code review effort: 2 (Simple) | ~15 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/settings.json:
- Around line 3-7: Disable automatic approval of all project MCP servers by
removing enableAllProjectMcpServers or setting it to false in the configuration.
Preserve enabledMcpjsonServers as the explicit allowlist containing context7 and
github.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 20691407-1d78-4eb4-a6d6-f8e021551372
⛔ Files ignored due to path filters (1)
okf/GoogleStyleGuide.okf.zipis excluded by!**/*.zip
📒 Files selected for processing (8)
.claude/plans/.gitkeep.claude/settings.json.coderabbit.yaml.cspell.json.gitignore.mcp.jsonAGENTS.mdCLAUDE.md
There was a problem hiding this comment.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/workflows/ci.yml (1)
18-24: 🚀 Performance & Scalability | 🔵 TrivialCancel superseded workflow runs.
Without a
concurrencygroup, older checks continue after a newer push or pull request update. Addcancel-in-progress: trueto reduce runner usage and stale work.Proposed configuration
+concurrency: + group: check-okf-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + permissions:🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/ci.yml around lines 18 - 24, Add a workflow-level concurrency configuration in .github/workflows/ci.yml with cancel-in-progress enabled, using a group key that identifies the relevant branch or pull request workflow so superseded runs are canceled while unrelated runs remain independent.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.cursor/mcp.json:
- Around line 4-7: Update the Context7 MCP entry in the mcp configuration to
replace the mutable `@latest` version in the npx arguments with a specific
reviewed package version, preserving the existing command and startup options.
In @.github/workflows/ci.yml:
- Around line 5-13: Replace the incorrect workflow path entry in both the push
and pull_request paths filters with the actual .github/workflows/ci.yml path,
preserving the existing okf/** and Makefile entries.
In `@AGENTS.md`:
- Around line 9-13: Clarify the bundle documentation so index.md may contain
only the optional okf_version frontmatter, while every other .md file must
contain a parseable frontmatter block with a non-empty type; remove the
contradictory statement that index.md is the only file allowed frontmatter.
In `@Makefile`:
- Around line 2-8: Update the Makefile target check-okf to require each
top-level *.okf.zip entry to be a regular file, verify its ZIP integrity, and
invoke the repository’s OKF validator for every archive before succeeding.
Preserve the existing rejection of unexpected top-level entries and ensure any
failed file-type, ZIP, or semantic validation exits nonzero.
- Around line 3-8: Update the Makefile validation recipe around the bad
assignment so failures from find are propagated instead of being masked by an
empty result. Check that okf exists before running find, and exit nonzero when
the directory is missing or find fails; retain the existing rejection of
non-*.okf.zip entries.
---
Outside diff comments:
In @.github/workflows/ci.yml:
- Around line 18-24: Add a workflow-level concurrency configuration in
.github/workflows/ci.yml with cancel-in-progress enabled, using a group key that
identifies the relevant branch or pull request workflow so superseded runs are
canceled while unrelated runs remain independent.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 2027ab5d-0532-43a8-91ee-c6a0a7761c83
📒 Files selected for processing (8)
.claude/skills/context7-docs/SKILL.md.claude/skills/debug-third-party/SKILL.md.cursor/mcp.json.cursor/skills/context7-docs/SKILL.md.cursor/skills/debug-third-party/SKILL.md.github/workflows/ci.ymlAGENTS.mdMakefile
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/ci.yml:
- Around line 7-9: Add a workflow-level concurrency configuration to the CI
workflow, grouping runs by workflow name and branch or pull-request identity,
and enable cancel-in-progress so superseded runs are terminated. Keep the
existing trigger and job definitions unchanged.
- Line 25: Pin the executable versions used by the validation gate: in
.github/workflows/ci.yml at lines 25-25, install a reviewed exact pnpm version
or use a SHA-pinned setup action; in scripts/check-okf.sh at lines 52-52, invoke
a reviewed exact `@thisismydesign/okf-lint` version. Verify the current CLI
documentation before selecting versions and use lockfile or equivalent
integrity-controlled sources where applicable.
- Around line 31-32: Update both actions/checkout steps in the CI workflow to
set persist-credentials to false, including the checkout preceding make
shellcheck and the other checkout that executes code from PR-controlled changes.
Keep the existing checkout versions and workflow commands unchanged.
In `@AGENTS.md`:
- Around line 9-14: Update the bundle documentation in the diff so okf_version
is explicitly optional for the bundle-root index.md. Separate the reserved-file
rule from the bundle-root exception, preserving that index.md and log.md
generally have no frontmatter while allowing the root index.md to declare
okf_version when present.
In `@Makefile`:
- Around line 5-6: Update the Makefile shellcheck target to discover shell
scripts recursively under scripts/ using the appropriate recursive glob pattern,
and ensure ShellCheck failures do not terminate the target by preserving a
non-failing command result.
In `@scripts/check-okf.sh`:
- Around line 58-65: Validate that okf_dir is an existing directory before the
find-based contents check and archive validation in scripts/check-okf.sh. If it
is missing or resolves to a regular file, emit an error and exit nonzero;
preserve the existing validation behavior for valid directories.
- Around line 36-42: Update the archive-root validation in the check function
containing roots so it enumerates all immediate entries under dest, including
files, and requires exactly one entry. Then validate that the sole entry is a
real directory before continuing; reject archives containing any extra top-level
files or directories while preserving the existing status and return behavior.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: b8b734ae-ebf2-470a-aebf-63554a34f088
⛔ Files ignored due to path filters (1)
okf/GoogleStyleGuide.okf.zipis excluded by!**/*.zip
📒 Files selected for processing (9)
.claude/settings.json.cspell.json.cursor/plans/.gitignore.github/workflows/ci.yml.shellcheckrcAGENTS.mdLICENSEMakefilescripts/check-okf.sh
Owner
Author
|
@coderabbitai full review |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The pull request adds an
okfbundle for the Google Developer Documentation Style Guide and some checks.Added
okf/GoogleStyleGuide.okf.zip. Around 95 pages fromhttps://developers.google.com/style, converted to markdown with YAML
frontmatter and organized into an OKF v0.1 bundle.
make check-okfvalidates every bundle before it ships:okf/holdsnothing but
*.okf.zip, each archive unzips cleanly, each contains asingle top-level directory holding a
.okflintrc.json, and each lintscleanly with
okf-lint.make shellcheckruns ShellCheck acrossscripts/.that touch
okf/,scripts/, theMakefile, or the workflow itself..DS_Store,__MACOSX) is ignored by git and maskedthroughout the checks.
LICENSEcovering the repository itself, separate from the licensesof the bundled content.
AGENTS.md, referenced fromCLAUDE.md, describingthe bundle layout and the checks that gate it.
context7-docsfetches current library documentation before code is written against it,
and
debug-third-partychecks for a known upstream bug before aworkaround is built.
Changed
from building the folder to opening a pull request.
Summary by CodeRabbit
Documentation
Chores
CI