Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[SEC-004] Harden devdocsai-js package security and provenance#7

Open
Wentzel-DevDocs wants to merge 3 commits into
maindevdocsorg/devdocsai-js:mainfrom
codex/sec-004-devdocsai-js-package-provenancedevdocsorg/devdocsai-js:codex/sec-004-devdocsai-js-package-provenanceCopy head branch name to clipboard
Open

[SEC-004] Harden devdocsai-js package security and provenance#7
Wentzel-DevDocs wants to merge 3 commits into
maindevdocsorg/devdocsai-js:mainfrom
codex/sec-004-devdocsai-js-package-provenancedevdocsorg/devdocsai-js:codex/sec-004-devdocsai-js-package-provenanceCopy head branch name to clipboard

Conversation

@Wentzel-DevDocs

@Wentzel-DevDocs Wentzel-DevDocs commented May 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add docs/compliance/package-security-provenance.md as the SEC-004 package security and provenance baseline.
  • Document npm publishing controls, token handling, package integrity, provenance target state, SBOM/dependency evidence, CI gates, release workflow, explicit gaps, evidence artifacts, and exact verification commands.

Validation

  • npm ci completed successfully; npm reported existing audit findings during install.
  • npm run lint passed after formatting the new Markdown document.
  • npm run test passed: 17 test files, 143 tests.
  • npm run build passed; generated .tgz pack artifacts were removed before commit.

Blockers

  • None.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive release workflow documentation to security baseline standards, outlining maintainer release procedures, automated release processes, and compliance requirements including package versioning, build procedures, and release evidence archival.

@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

A new "Release Workflow" subsection is added to docs/compliance/package-security-provenance.md under the SEC-004 baseline. It defines a maintainer release sequence and an automated post-merge release sequence, including npm publishing and evidence archiving steps.

Changes

SEC-004 Release Workflow Documentation

Layer / File(s) Summary
Release Workflow section
docs/compliance/package-security-provenance.md
Inserts two ordered sequences: a maintainer-driven process (branching, npm ci, lint/test/build, Changesets, PR creation) and an automated post-merge process (release workflow on main, Changesets version PR handling, npm publish, archiving SBOM/audit/tarball/provenance evidence).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • devdocsorg/devdocsai-js#15: Introduced the SEC-004 package provenance compliance document that this PR extends with the new "Release Workflow" subsection.

Poem

🐇 A rabbit hops through release land,
With Changesets clutched in paw and hand.
Branch cut, CI green, the tarball sealed,
Provenance logged, the audit revealed.
Into main the merge completes—
npm publish, the workflow beats! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding SEC-004 compliance documentation for package security and provenance to the devdocsai-js package.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/sec-004-devdocsai-js-package-provenance

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.

@Wentzel-DevDocs

Copy link
Copy Markdown
Contributor Author

Autonomous SOC2 cleanup disposition (2026-05-24): superseded by WENTZEL #15.

This draft adds docs/compliance/package-security-provenance.md from a non-WENTZEL codex/ branch. WENTZEL #15 recreates the provenance baseline on WENTZEL_DEV-100-js-package-provenance, links it from the README, and updates the doc against the current workflow/security-control state.

Current state: open draft, clean merge state, CI green on 2026-05-12 (lint/test/bundle-size plus CodeRabbit status).

Recommendation: leave this unmerged; after #15 lands, maintainers can close this duplicate. Not closing per cleanup rules.

@Wentzel-DevDocs Wentzel-DevDocs marked this pull request as ready for review May 25, 2026 00:48
@Wentzel-DevDocs

Copy link
Copy Markdown
Contributor Author

Ready-for-review handoff:

  • Configured checks are green/non-blocking.
  • Merge state was reported CLEAN in the GitHub sweep.
  • No code changes made during this handoff; this only moves the PR out of draft for human review.
  • Do not merge from automation. Do not close the Linear item until a human approves, the PR merges to main, and post-merge main status is verified green.

Rebuild the SEC-004 baseline on current main. The original branch
(codex/sec-004) forked from before the React 18+19 work (#8), the
version pins (#11), and the config rename, so its PR diff spuriously
reverted all of that. This re-applies the single substantive change —
docs/compliance/package-security-provenance.md — cleanly on top of main
so the PR contains only the doc.

Doc verified: no stale markprompt/React refs, all referenced manifests
and workflows exist on main, passes prettier and remark.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Wentzel-DevDocs Wentzel-DevDocs force-pushed the codex/sec-004-devdocsai-js-package-provenance branch from e1a4758 to 4b6c1d1 Compare May 27, 2026 22:39
Resolve add/add conflict in docs/compliance/package-security-provenance.md
by unioning the merged main (PR #15) SOC 2 baseline with the unique
"Release Workflow" maintainer/automation sequence from this branch.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@coderabbitai coderabbitai 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.

🧹 Nitpick comments (1)
docs/compliance/package-security-provenance.md (1)

150-175: ⚡ Quick win

Clarify whether step 5 is automated or manual, given the section title.

The section header "Automated release sequence after merge" describes steps 1–4 (which are fully automated by the release workflow), but step 5 ("Maintainers archive...") is manual post-release work. Since the Explicit Gaps section (lines 201–204) already documents that "SBOM, audit, signature, and tarball-manifest artifacts are not uploaded by the current main release workflow," consider restructuring this to separate automated from manual steps, or rename the section to clarify the boundary.

For example:

  • Option A: Rename the section to "Release Sequence" and clearly label steps 1–4 as "Automated" and step 5 as "Manual follow-up."
  • Option B: Move step 5 to a new subsection titled "Post-Release Archival" below the current section.

The content itself is accurate per the actual release.yml and the documented gaps, but the structure could be clearer to avoid confusion.

🤖 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 `@docs/compliance/package-security-provenance.md` around lines 150 - 175, The
section titled "Automated release sequence after merge" mixes automated steps
(1-4 handled by GitHub Actions) with manual post-release work (step 5 about
archiving artifacts by maintainers). Restructure this section to clearly
separate automated from manual steps: either rename the section to "Release
Sequence" and explicitly label steps 1-4 as automated and step 5 as manual
follow-up work, or move step 5 ("Maintainers archive the release workflow
run...") to a separate subsection titled "Post-Release Archival" positioned
below the current section to avoid confusion about what is automated.
🤖 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.

Nitpick comments:
In `@docs/compliance/package-security-provenance.md`:
- Around line 150-175: The section titled "Automated release sequence after
merge" mixes automated steps (1-4 handled by GitHub Actions) with manual
post-release work (step 5 about archiving artifacts by maintainers). Restructure
this section to clearly separate automated from manual steps: either rename the
section to "Release Sequence" and explicitly label steps 1-4 as automated and
step 5 as manual follow-up work, or move step 5 ("Maintainers archive the
release workflow run...") to a separate subsection titled "Post-Release
Archival" positioned below the current section to avoid confusion about what is
automated.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 65a91007-b0dc-4dbd-948d-048fa0b13bef

📥 Commits

Reviewing files that changed from the base of the PR and between d2dc403 and ac5306e.

📒 Files selected for processing (1)
  • docs/compliance/package-security-provenance.md

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

Morty Proxy This is a proxified and sanitized view of the page, visit original site.