3squaredcircles/signet repository overview

Visit https://docs.3squaredcircles.com⁠ for a deep dive into configuration.

Feedback welcomed at https://www.linkedin.com/company/3-squared-circles/⁠

The Automated Scribe for Your CI/CD Pipeline.

3SC Signet is the release documentation engine for the 3SC Automated Governance Platform. It runs as the final step in a CI/CD pipeline, automatically discovering artifacts produced by other 3SC tools, enriching them with context from your Git history and work item provider, and publishing them as a comprehensive, human-readable release manifest.

Signet eliminates the manual, error-prone work of assembling release notes, creating a perfect, auditable, and consistent "paper trail" for every deployment.

⁠A Note on the Name

A Signet was a small, personal seal used historically to authorize and authenticate official documents. This name was chosen because the tool acts as the final, authoritative seal on your release process, creating a verifiable and trustworthy document of record for every deployment.

---

⁠For the Manager (VP, Director of Engineering)

As a leader, you need visibility and traceability in your release process for compliance, auditing, and stakeholder communication. Manual release notes are often inconsistent, incomplete, or created days after the fact. Signet automates this critical documentation step.

Signet answers your critical questions:

• "How can we generate consistent, professional release notes for every single deployment, without any manual effort?"
• "How can we get a single, consolidated report that shows all the automated quality and security checks that passed for a given release?"
• "How do we provide auditors with an immutable, easy-to-read record of every deployment, including the code changes, work items, and QA evidence?"
• "How can we automatically notify stakeholders by publishing our release notes to a central wiki like Confluence or Notion?"

⁠Key Business Values:

• Automate Release Communication: Eliminate the time developers and release managers spend manually compiling release notes. Signet does it automatically on every run.
• Achieve "Audit-Ready" Compliance: The generated release manifest is a complete, version-controlled audit artifact that links code changes, work items, and evidence from every automated gate in your pipeline.
• Improve Visibility & Transparency: Provide all stakeholders—from developers to executives—with a single, consistent, and easy-to-understand view of what is included in every release.
• Centralize Release Documentation: Automatically publish detailed release pages to your existing knowledge management systems like Confluence, Notion, or a Git-based wiki.

---

⁠For the Engineer & SRE

As an engineer, you want to focus on shipping code, not on writing documentation. Signet is a "zero-touch" tool that runs in the background of your pipeline, creating the documentation for you.

Signet is the chronicler of your pipeline's journey.

⁠Key Technical Values:

• Automated Artifact Discovery: Signet automatically scans the pipeline workspace for known artifacts from other 3SC tools (scrutari-report.json, protega-report.json, etc.) and third-party tools (in the evidence/ directory).
• Git & Work Item Enrichment: The tool analyzes your Git history to find all commit messages since the last release tag and parses them to extract work item IDs (e.g., AB-123, GH-45). It then connects to your work item provider (Jira, Azure DevOps, etc.) to enrich these IDs with titles, types, and links.
• Forensic Logging: Signet reads the pipeline-log.json file created by other 3SC tools to include the exact configuration and version of every tool that ran, providing a deep, auditable forensic record.
• Pluggable Publishers: The generated release notes can be automatically published to multiple destinations, including a Git Wiki, Confluence, or Notion, using a simple configuration switch.

Verifying Image Signatures All published images are signed with Cosign. To verify:

Install cosign: https://docs.sigstore.dev/cosign/system_config/installation/⁠ Download our public key: curl -O https://www.3squaredsquaredcircles.com/keys/3squaredcircles.pub⁠ Verify: cosign verify --key 3squaredcircles.pub 3squaredcircles/signet:latest