Skip to content

[codex] Align briefprint docs and metadata#17

Merged
dd3ok merged 2 commits into
mainfrom
codex/briefprint-consistency-cleanup
Jul 4, 2026
Merged

[codex] Align briefprint docs and metadata#17
dd3ok merged 2 commits into
mainfrom
codex/briefprint-consistency-cleanup

Conversation

@dd3ok

@dd3ok dd3ok commented Jul 4, 2026

Copy link
Copy Markdown
Owner

Summary

  • Refresh validation evidence and current implementation status docs for Briefprint.
  • Clarify briefprint skill naming versus document-briefing-cache runtime/package naming.
  • Align root and installable OpenAI metadata, install docs, privacy guidance, and secret-redaction caveats.
  • Remove the unused corrupt_hmac_failed cache event reason and add focused regression coverage for corrupt document-cache events.

Validation

  • python -m pytest -q -p no:cacheprovider -> 164 passed, 2 skipped
  • python scripts\validate_skill.py --run-evals -> OK: briefprint skill repository validated (24 test files, 9 eval cases, 9 trigger cases, 4 model benchmark cases)
  • ruff check . -> All checks passed!
  • git diff --check -> no whitespace errors
  • rg -n "Status: proposed|corrupt_hmac_failed" src references tests README.md README.ko.md docs/agent-skill-installation.md agents scripts skills -> no output

Notes

Local agent workflow artifacts (.agent/, .superpowers/, and docs/superpowers/plans/2026-07-04-briefprint-consistency-cleanup-plan.md) were intentionally left out of this PR because they are execution records rather than product or repository-facing changes.

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

Copy link
Copy Markdown

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 documentation across several files to align with the current implementation status, clarifies naming conventions, and documents the behavior of the --sensitive and --redact-secrets flags. It also removes the unused corrupt_hmac_failed event reason from the models and adds corresponding tests. The review feedback suggests improving test robustness by avoiding hardcoded date assertions in test_installable_skill_bundle.py and safely extracting cache keys in test_pipeline_cache.py to prevent potential StopIteration errors.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +74 to +80
for section in [
"Verified surfaces",
"Community-compatible notes",
"Last checked: 2026-07-04",
"Verify installed files",
]:
assert section in doc

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Hardcoding the exact date "Last checked: 2026-07-04" in the test assertion makes the test fragile to future documentation updates. If the documentation is updated with a new date, this test will fail. Consider using a regular expression to validate the presence of a date pattern instead.

Suggested change
for section in [
"Verified surfaces",
"Community-compatible notes",
"Last checked: 2026-07-04",
"Verify installed files",
]:
assert section in doc
for section in [
"Verified surfaces",
"Community-compatible notes",
"Verify installed files",
]:
assert section in doc
assert re.search(r"Last checked: \\d{4}-\\d{2}-\\d{2}", doc)

Comment thread tests/test_pipeline_cache.py Outdated
doc = DocumentInput(document_id="corrupt-doc", title="Corrupt", text="Action: owner should inspect cache.")
pipeline = BriefingPipeline(cache_dir=tmp_path)
first = pipeline.run([doc], use_output_cache=False)
key = first.stats.cache_keys[next(name for name in first.stats.cache_keys if name.startswith("document:"))]

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Using next() with a generator expression on cache_keys will raise a StopIteration if no matching key is found, which can be hard to debug. Explicitly extracting the keys and asserting that exactly one document key exists improves test robustness and error clarity.

Suggested change
key = first.stats.cache_keys[next(name for name in first.stats.cache_keys if name.startswith("document:"))]
doc_keys = [k for k in first.stats.cache_keys if k.startswith("document:")]
assert len(doc_keys) == 1
key = first.stats.cache_keys[doc_keys[0]]

@dd3ok
dd3ok marked this pull request as ready for review July 4, 2026 23:29
@dd3ok
dd3ok merged commit 70f91d8 into main Jul 4, 2026
4 checks passed
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