From faa84c8ccc5b3fd72ccc4c1950ad769be3bbdce2 Mon Sep 17 00:00:00 2001 From: sabith Date: Fri, 13 Nov 2026 12:29:28 -0800 Subject: [PATCH] docs: add developer GitHub Pages site --- .github/workflows/pages.yml | 42 +++++ README.md | 6 +- docs/.nojekyll | 0 docs/README.md | 28 ++++ docs/assets/styles.css | 320 ++++++++++++++++++++++++++++++++++++ docs/index.html | 314 +++++++++++++++++++++++++++++++++++ 6 files changed, 708 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/pages.yml create mode 100644 docs/.nojekyll create mode 100644 docs/README.md create mode 100644 docs/assets/styles.css create mode 100644 docs/index.html diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..ee31219 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,42 @@ +name: GitHub Pages + +on: + push: + branches: [main] + paths: + - docs/** + - .github/workflows/pages.yml + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: true + +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Configure Pages + uses: actions/configure-pages@v5 + with: + enablement: true + + - name: Upload the static docs site + uses: actions/upload-pages-artifact@v3 + with: + path: docs + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index 765b335..f7d3a69 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # cce-action -GitHub Action and reusable workflow that runs [StackGen CCE](https://appcd-dev.github.io/cce/) against the repository where the workflow is running. +**[Developer guide and examples](https://stackgenhq.github.io/cce-action/)** · [Workflow examples](examples/) · [CCE documentation](https://appcd-dev.github.io/cce/) + +GitHub Action and reusable workflows that run [StackGen CCE](https://appcd-dev.github.io/cce/) against the repository where the workflow is running. Both the composite action and the reusable workflow install `cce` by pulling [`ghcr.io/stackgenhq/cce`](https://github.com/stackgenhq/homebrew-stackgen/pkgs/container/cce) @@ -215,7 +217,7 @@ or checking the repo size in a prior step. ## Versioning -Use a major tag (`@v1`) or a pinned release (`@v0.2.0`). The action's default image is fixed to its tested CLI release; override `image` (for example `ghcr.io/stackgenhq/cce:0.0.38`) when you deliberately need another CLI. +Use a major tag (`@v1`) or a pinned release (`@v0.3.0`). The action's default image is fixed to its tested CLI release; override `image` (for example `ghcr.io/stackgenhq/cce:0.0.38`) when you deliberately need another CLI. Releases are cut from the **Release** workflow (Actions tab -> Run workflow on `main`). The workflow refuses to release unless Self-test is green for the diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..1926d28 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,28 @@ +# CCE Action developer site + +This directory is the complete static site published at +. It intentionally uses plain HTML and +CSS: there is no site generator, package install, external font, or client-side +JavaScript to maintain. + +## Preview locally + +From the repository root: + +```bash +python3 -m http.server 8000 --directory docs +``` + +Open . + +## Update the site + +- Edit `index.html` for content and `assets/styles.css` for presentation. +- Keep examples aligned with the versioned files in `../examples/`. +- Link to the action README for exhaustive input/output tables rather than + duplicating every option on the landing page. +- Preserve the short explanations of static-analysis and IAM-review limits. + +A push to `main` that changes this directory runs `.github/workflows/pages.yml`, +which uploads `docs/` and deploys it with GitHub Pages. The workflow can also be +run manually from the Actions tab. diff --git a/docs/assets/styles.css b/docs/assets/styles.css new file mode 100644 index 0000000..c76ea07 --- /dev/null +++ b/docs/assets/styles.css @@ -0,0 +1,320 @@ +/* CCE Action's public site: no frameworks, external fonts, or client-side code. */ +:root { + --ink: #172b2a; + --muted: #526665; + --forest: #123f3a; + --forest-deep: #0b2927; + --mint: #bcebd6; + --mint-bright: #7ce0b8; + --paper: #fbfcf8; + --tint: #f0f5ef; + --line: #d9e2dc; + --white: #ffffff; + --coral: #e87955; + --shadow: 0 24px 70px rgba(17, 50, 45, 0.12); + --radius: 18px; + --max-width: 1160px; +} + +* { box-sizing: border-box; } +html { scroll-behavior: smooth; scroll-padding-top: 88px; } +body { + margin: 0; + color: var(--ink); + background: var(--paper); + font-family: Inter, ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif; + font-size: 16px; + line-height: 1.65; + -webkit-font-smoothing: antialiased; +} +a { color: inherit; text-decoration: none; } +a:focus-visible, summary:focus-visible { + outline: 3px solid var(--coral); + outline-offset: 4px; + border-radius: 3px; +} +img, svg { max-width: 100%; } +code, pre { + font-family: "SFMono-Regular", Consolas, "Liberation Mono", monospace; +} +code { + padding: 0.12em 0.35em; + border-radius: 5px; + background: rgba(18, 63, 58, 0.07); + font-size: 0.9em; +} +.container { width: min(calc(100% - 48px), var(--max-width)); margin-inline: auto; } +.skip-link { + position: fixed; + z-index: 100; + top: 12px; + left: 12px; + padding: 8px 14px; + color: var(--white); + background: var(--forest-deep); + border-radius: 6px; + transform: translateY(-150%); +} +.skip-link:focus { transform: translateY(0); } + +.site-header { + position: sticky; + z-index: 20; + top: 0; + border-bottom: 1px solid rgba(217, 226, 220, 0.8); + background: rgba(251, 252, 248, 0.94); + backdrop-filter: blur(16px); +} +.header-inner { min-height: 74px; display: flex; align-items: center; gap: 36px; } +.brand { display: inline-flex; align-items: center; gap: 10px; font-size: 18px; font-weight: 760; letter-spacing: -0.03em; } +.brand-mark { + display: grid; + width: 34px; + height: 34px; + place-items: center; + color: var(--forest-deep); + background: var(--mint-bright); + border-radius: 10px 10px 10px 3px; + font-size: 20px; + font-weight: 850; +} +nav { display: flex; align-items: center; gap: 28px; margin-left: auto; } +nav a { color: var(--muted); font-size: 14px; font-weight: 650; } +nav a:hover { color: var(--forest); } +.button { + display: inline-flex; + min-height: 48px; + align-items: center; + justify-content: center; + gap: 8px; + padding: 12px 21px; + color: var(--white); + background: var(--forest); + border: 1px solid var(--forest); + border-radius: 9px; + box-shadow: 0 5px 14px rgba(18, 63, 58, 0.15); + font-weight: 700; + line-height: 1.2; + transition: transform 150ms ease, background 150ms ease; +} +.button:hover { background: #1a514a; transform: translateY(-2px); } +.button-small { min-height: 38px; padding: 8px 14px; font-size: 14px; box-shadow: none; } +.button-outline { color: var(--forest); background: transparent; } +.button-outline:hover { color: var(--white); } +.text-link { display: inline-flex; align-items: center; gap: 8px; color: var(--forest); font-weight: 750; } +.text-link:hover { text-decoration: underline; text-underline-offset: 5px; } + +.hero { position: relative; overflow: hidden; padding: 102px 0 112px; } +.hero::before { + position: absolute; + z-index: -1; + width: 540px; + height: 540px; + top: -220px; + right: -120px; + border: 1px solid var(--line); + border-radius: 50%; + box-shadow: 0 0 0 90px rgba(240, 245, 239, 0.55), 0 0 0 180px rgba(240, 245, 239, 0.3); + content: ""; +} +.hero-grid { display: grid; grid-template-columns: 1.08fr 0.92fr; align-items: center; gap: 74px; } +.eyebrow { + margin: 0 0 18px; + color: #286e5d; + font-size: 12px; + font-weight: 800; + letter-spacing: 0.13em; + line-height: 1.4; + text-transform: uppercase; +} +h1, h2, h3, p { margin-top: 0; } +h1, h2, h3 { line-height: 1.13; } +h1 { max-width: 700px; margin-bottom: 26px; font-size: clamp(44px, 5.6vw, 72px); font-weight: 780; letter-spacing: -0.058em; } +h2 { margin-bottom: 18px; font-size: clamp(30px, 3.4vw, 44px); font-weight: 750; letter-spacing: -0.042em; } +h3 { margin-bottom: 12px; font-size: 20px; letter-spacing: -0.025em; } +.hero-lede { max-width: 620px; margin-bottom: 30px; color: var(--muted); font-size: 19px; line-height: 1.65; } +.hero-actions { display: flex; align-items: center; flex-wrap: wrap; gap: 24px; } +.hero-notes { display: flex; flex-wrap: wrap; gap: 10px 22px; margin: 28px 0 0; padding: 0; color: var(--muted); font-size: 13px; list-style: none; } +.hero-notes li::before { margin-right: 7px; color: #287e62; content: "✓"; font-weight: 800; } + +.hero-visual { position: relative; padding: 28px 0; } +.report-card { + position: relative; + z-index: 2; + overflow: hidden; + background: var(--white); + border: 1px solid #dce6df; + border-radius: 20px; + box-shadow: var(--shadow); + transform: rotate(1.5deg); +} +.report-heading { display: flex; align-items: flex-start; justify-content: space-between; gap: 12px; padding: 26px 26px 20px; background: #f7faf7; } +.report-kicker { color: var(--muted); font-size: 11px; font-weight: 700; letter-spacing: 0.08em; text-transform: uppercase; } +.report-heading h2 { margin: 4px 0 0; font-size: 23px; letter-spacing: -0.03em; } +.status { display: inline-flex; align-items: center; gap: 6px; padding: 5px 9px; color: #23614f; background: #e3f5ea; border-radius: 30px; font-size: 11px; font-weight: 750; } +.status span { width: 6px; height: 6px; background: #39a675; border-radius: 50%; } +.report-row { display: grid; grid-template-columns: 52px 1fr auto; align-items: center; gap: 14px; padding: 21px 24px; border-top: 1px solid #e6ece7; } +.report-row > div { display: grid; gap: 5px; } +.report-row strong { font-size: 14px; } +.report-row code { width: fit-content; padding: 0; color: #526665; background: none; font-size: 12px; } +.provider { display: grid; width: 46px; height: 32px; place-items: center; border-radius: 6px; font-size: 10px; font-weight: 850; letter-spacing: 0.04em; } +.provider-aws { color: #81521e; background: #fff0d9; } +.provider-gcp { color: #296299; background: #e4f0ff; } +.provider-azure { color: #276b88; background: #e0f3fa; } +.evidence { color: var(--muted); font-size: 11px; white-space: nowrap; } +.report-footer { display: flex; justify-content: space-between; gap: 10px; padding: 14px 24px; color: #dcece5; background: var(--forest-deep); font-size: 10px; } +.visual-note { position: absolute; z-index: 3; padding: 10px 15px; color: var(--forest-deep); background: var(--mint); border: 1px solid rgba(18, 63, 58, 0.08); border-radius: 9px; box-shadow: 0 10px 30px rgba(17, 50, 45, 0.12); font-size: 12px; font-weight: 750; } +.note-top { top: 0; right: -22px; transform: rotate(3deg); } +.note-bottom { bottom: 0; left: -28px; color: var(--white); background: var(--coral); transform: rotate(-3deg); } + +.proof-strip { border-block: 1px solid var(--line); background: var(--tint); } +.proof-inner { display: flex; min-height: 82px; align-items: center; justify-content: space-between; gap: 30px; } +.proof-inner > span { color: var(--muted); font-size: 12px; font-weight: 750; letter-spacing: 0.06em; text-transform: uppercase; } +.proof-inner ul { display: flex; flex-wrap: wrap; justify-content: flex-end; gap: 14px 30px; margin: 0; padding: 0; font-size: 14px; font-weight: 700; list-style: none; } + +.section { padding: 104px 0; } +.section-tinted { background: var(--tint); } +.section-heading { max-width: 760px; margin: 0 auto 50px; text-align: center; } +.section-heading > p:not(.eyebrow) { max-width: 670px; margin-inline: auto; color: var(--muted); font-size: 17px; } +.section-heading.align-start { margin: 0; text-align: left; } +.section-heading.align-start > p:not(.eyebrow) { margin-inline: 0; } +.feature-grid { display: grid; grid-template-columns: repeat(3, 1fr); gap: 22px; } +.feature-card { padding: 30px; background: var(--white); border: 1px solid var(--line); border-radius: var(--radius); } +.feature-card p { margin-bottom: 0; color: var(--muted); } +.feature-number { display: inline-block; margin-bottom: 34px; color: var(--coral); font-family: "SFMono-Regular", Consolas, monospace; font-size: 13px; font-weight: 800; } + +.split-layout { display: grid; grid-template-columns: 0.85fr 1.15fr; align-items: center; gap: 70px; } +.steps { display: grid; gap: 13px; margin: 30px 0; padding: 0; list-style: none; } +.steps li { display: flex; align-items: center; gap: 12px; font-size: 14px; font-weight: 650; } +.steps li > span { display: grid; flex: 0 0 26px; width: 26px; height: 26px; place-items: center; color: var(--forest); background: var(--mint); border-radius: 50%; font-size: 11px; } +.code-window { overflow: hidden; background: #102b29; border: 1px solid #284641; border-radius: 15px; box-shadow: 0 20px 50px rgba(18, 48, 43, 0.16); } +.code-heading { display: flex; justify-content: space-between; gap: 20px; padding: 13px 19px; color: #b8cec6; background: #183835; border-bottom: 1px solid #31504b; font-size: 11px; font-weight: 650; } +.code-window pre { overflow-x: auto; margin: 0; padding: 25px; color: #ecf8f1; font-size: 13px; line-height: 1.8; tab-size: 2; } +.code-window code { padding: 0; color: inherit; background: none; font-size: inherit; } +.code-muted { color: #8bd9b8; } +.callout { display: flex; align-items: center; gap: 16px; margin-top: 46px; padding: 18px 22px; background: rgba(255, 255, 255, 0.7); border: 1px solid var(--line); border-radius: 10px; font-size: 13px; } +.callout strong { white-space: nowrap; } +.callout span { color: var(--muted); } + +.workflow-list { border-top: 1px solid var(--line); } +.workflow-item { display: grid; grid-template-columns: 58px 1fr auto; align-items: center; gap: 24px; padding: 25px 10px; border-bottom: 1px solid var(--line); } +.workflow-item h3 { margin-bottom: 5px; } +.workflow-item p { max-width: 680px; margin-bottom: 0; color: var(--muted); } +.workflow-item > a { color: var(--forest); font-size: 13px; font-weight: 750; white-space: nowrap; } +.workflow-item > a:hover { text-decoration: underline; text-underline-offset: 4px; } +.workflow-icon { display: grid; width: 50px; height: 50px; place-items: center; color: var(--forest); background: var(--tint); border: 1px solid var(--line); border-radius: 13px; font-family: "SFMono-Regular", Consolas, monospace; font-size: 13px; font-weight: 850; } + +.section-dark { color: #f3faf6; background: var(--forest-deep); } +.split-reverse { grid-template-columns: 1fr 1fr; } +.section-dark h2 { color: var(--white); } +.section-dark .section-heading > p:not(.eyebrow) { color: #b8cbc5; } +.eyebrow-light { color: var(--mint-bright); } +.code-window-dark { background: #071d1c; box-shadow: none; } +.lens-points { display: grid; grid-template-columns: 1fr 1fr; gap: 16px; margin-top: 20px; } +.lens-points > div { display: grid; gap: 5px; padding: 15px; border: 1px solid #31504b; border-radius: 10px; } +.lens-points strong { font-size: 13px; } +.lens-points span { color: #aac1b9; font-size: 12px; } +.check-list { display: grid; gap: 11px; margin: 26px 0; padding: 0; list-style: none; } +.check-list li::before { margin-right: 10px; color: var(--mint-bright); content: "✓"; font-weight: 800; } +.text-link-light { color: var(--mint-bright); } + +.trust-grid { display: grid; grid-template-columns: repeat(4, 1fr); gap: 24px; } +.trust-grid article { padding-top: 22px; border-top: 2px solid var(--mint); } +.trust-grid h3 { font-size: 17px; } +.trust-grid p { margin-bottom: 0; color: var(--muted); font-size: 14px; } +.note-box { margin-top: 44px; padding: 23px 26px; background: #fff6ec; border-left: 4px solid var(--coral); border-radius: 0 10px 10px 0; } +.note-box strong { font-size: 15px; } +.note-box p { margin: 6px 0 0; color: #655c53; font-size: 14px; } + +.details-grid { display: grid; grid-template-columns: 1fr 0.85fr; gap: 90px; } +.details-grid h2 { font-size: 34px; } +.details-list { margin: 28px 0 0; } +.details-list > div { display: grid; grid-template-columns: 130px 1fr; gap: 20px; padding: 16px 0; border-top: 1px solid var(--line); } +.details-list dt { font-weight: 750; } +.details-list dd { margin: 0; color: var(--muted); font-size: 14px; } +.faq details { border-top: 1px solid var(--line); } +.faq details:last-child { border-bottom: 1px solid var(--line); } +.faq summary { position: relative; padding: 18px 28px 18px 0; cursor: pointer; font-weight: 700; list-style: none; } +.faq summary::-webkit-details-marker { display: none; } +.faq summary::after { position: absolute; top: 16px; right: 0; color: var(--forest); content: "+"; font-size: 22px; font-weight: 400; } +.faq details[open] summary::after { content: "−"; } +.faq details p { margin: -4px 0 20px; color: var(--muted); font-size: 14px; } + +.final-cta { padding: 72px 0; border-top: 1px solid var(--line); } +.final-cta-inner { display: flex; align-items: center; justify-content: space-between; gap: 50px; } +.final-cta h2 { max-width: 660px; margin-bottom: 0; font-size: 36px; } +.final-cta .eyebrow { margin-bottom: 12px; } +.final-cta .hero-actions { flex-shrink: 0; flex-direction: column; align-items: flex-start; gap: 16px; } +.site-footer { padding: 36px 0; color: #c0d0ca; background: var(--forest-deep); } +.footer-inner { display: flex; align-items: center; justify-content: space-between; gap: 40px; } +.footer-inner > div:first-child { display: grid; gap: 4px; } +.footer-inner strong { color: var(--white); } +.footer-inner span { font-size: 12px; } +.footer-links { display: flex; flex-wrap: wrap; gap: 22px; font-size: 12px; } +.footer-links a:hover { color: var(--white); } + +@media (max-width: 980px) { + .header-inner { gap: 20px; } + nav { gap: 18px; } + .hero { padding: 76px 0 90px; } + .hero-grid { grid-template-columns: 1fr 0.85fr; gap: 40px; } + .hero-lede { font-size: 17px; } + .report-row { grid-template-columns: 48px 1fr; padding: 18px; } + .evidence { display: none; } + .visual-note { display: none; } + .split-layout, .split-reverse { gap: 40px; } + .trust-grid { grid-template-columns: repeat(2, 1fr); gap: 34px 24px; } + .details-grid { gap: 50px; } + .final-cta-inner { align-items: flex-start; flex-direction: column; gap: 28px; } + .final-cta .hero-actions { flex-direction: row; align-items: center; } +} + +@media (max-width: 760px) { + .container { width: min(calc(100% - 32px), var(--max-width)); } + .header-inner { min-height: 66px; } + .header-inner nav { display: none; } + .header-inner > .button { margin-left: auto; } + .hero { padding: 58px 0 65px; } + .hero-grid { grid-template-columns: 1fr; gap: 44px; } + h1 { font-size: clamp(42px, 12vw, 60px); } + .hero-lede { font-size: 17px; } + .hero-visual { width: min(100%, 480px); margin-inline: auto; } + .report-row { grid-template-columns: 52px 1fr auto; } + .evidence { display: inline; } + .proof-inner { align-items: flex-start; flex-direction: column; gap: 14px; padding-block: 23px; } + .proof-inner ul { justify-content: flex-start; gap: 12px 24px; } + .section { padding: 72px 0; } + .section-heading { margin-bottom: 34px; } + .feature-grid { grid-template-columns: 1fr; } + .feature-number { margin-bottom: 20px; } + .split-layout, .split-reverse { grid-template-columns: 1fr; } + .split-reverse > div:first-child { order: 2; } + .split-reverse > div:last-child { order: 1; } + .code-window pre { padding: 19px; font-size: 11px; } + .callout { align-items: flex-start; flex-direction: column; gap: 6px; } + .workflow-item { grid-template-columns: 50px 1fr; gap: 17px; padding: 22px 0; } + .workflow-item > a { grid-column: 2; } + .workflow-icon { width: 44px; height: 44px; } + .details-grid { grid-template-columns: 1fr; gap: 60px; } + .final-cta .hero-actions { align-items: flex-start; flex-direction: column; } + .footer-inner { align-items: flex-start; flex-direction: column; gap: 24px; } +} + +@media (max-width: 430px) { + .hero-actions { align-items: flex-start; flex-direction: column; gap: 18px; } + .hero-actions .button { width: 100%; } + .hero-notes { display: grid; } + .report-heading { padding: 20px; } + .report-row { grid-template-columns: 44px 1fr; padding: 16px 18px; } + .evidence { display: none; } + .report-footer { flex-direction: column; gap: 2px; } + .trust-grid { grid-template-columns: 1fr; } + .lens-points { grid-template-columns: 1fr; } + .details-list > div { grid-template-columns: 1fr; gap: 5px; } + .footer-links { gap: 14px 20px; } +} + +@media (prefers-reduced-motion: reduce) { + html { scroll-behavior: auto; } + *, *::before, *::after { transition: none !important; } +} diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..a5a7556 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,314 @@ + + + + + + + + + + + + CCE Action — Cloud API evidence in GitHub Actions + + + + + + + +
+
+
+
+

Open source · Built for GitHub Actions

+

See the cloud APIs your code actually uses.

+

CCE Action reads your source code and turns cloud SDK calls into clear, reviewable evidence. Add one workflow to inventory APIs, review changes, and prepare IAM access requests.

+ +
    +
  • No account required
  • +
  • Diagnostics off by default
  • +
  • Reports stay with your workflow
  • +
+
+ +
+
+
+
+ Cloud API inventory +

payments-api

+
+ Ready +
+
+ AWS +
Amazon S3PutObject
+ 2 call sites +
+
+ GCP +
Cloud Storagebucket
+ 1 call site +
+
+ Azure +
Blob StorageUpload
+ 3 call sites +
+ +
+
Code in. Evidence out.
+
Made for code review
+
+
+
+ +
+
+ Works across your stack +
    +
  • Go
  • +
  • Python
  • +
  • Java
  • +
  • JavaScript
  • +
  • AWS
  • +
  • Azure
  • +
  • Google Cloud
  • +
+
+
+ +
+
+
+

Useful on the first run

+

From “what does this service use?” to evidence you can share.

+

Cloud usage is often spread across code, tickets, and IAM policies. CCE gives developers and reviewers a common starting point.

+
+
+
+ 01 +

Build an API inventory

+

Find provider, resource, operation, and source-location evidence across supported languages. Export a machine-readable report for your own tools.

+
+
+ 02 +

Review what changed

+

See added and removed Cloud API calls in one pull-request comment. Keep the JSON, Markdown, and SARIF evidence for later.

+
+
+ 03 +

Start an access conversation

+

Give IAM reviewers a concise list of operations found in code. They decide the final policy and resource boundaries.

+
+
+
+
+ +
+
+
+

Quick start

+

One small workflow.
A useful first report.

+

Create .github/workflows/cce.yml in your repository. The workflow checks out your code, runs CCE, and uploads the results.

+
    +
  1. 1Add the workflow and commit it.
  2. +
  3. 2Open the CCE run in GitHub Actions.
  4. +
  5. 3Download the cce-results artifact.
  6. +
+ Open the complete example +
+
+
.github/workflows/cce.ymlYAML
+
name: CCE
+on: [push, pull_request]
+
+permissions:
+  contents: read
+  packages: read
+
+jobs:
+  scan:
+    uses: stackgenhq/cce-action/.github/workflows/scan.yml@v1
+    with:
+      language: AUTO
+      filter: cloud
+
+
+
+ Prefer a fixed version? + Use @v0.3.0 instead of @v1. The major tag receives compatible updates; an exact release stays fixed. +
+
+ +
+
+
+

Choose your starting point

+

Focused workflows for everyday engineering.

+

Start with a scan, then add only the capabilities your team needs.

+
+
+
+ +

Scan

Create a Cloud API report, IAM-related exports, and a cloud-neutral E-SBOM.

+ View example +
+
+ +

Pull-request review

Post a sticky Cloud API diff, publish SARIF, and optionally fail when new operations appear.

+ View example +
+
+ +

Access request

Package code-evidenced operations as versioned JSON for review in your IAM process.

+ View example +
+
+ +

Quickstart bundle

Share an HTML report, API inventory, SARIF, lens lockfile, and suggested CI workflow.

+ View example +
+
+ +

Lens verification

Test a proposed lens against committed fixtures and catch regressions before merging.

+ View example +
+
+
+
+ +
+
+
+
+
Typical lens inputsYAML
+
- uses: stackgenhq/cce-action@v1
+  with:
+    language: AUTO
+    lens: .cce/internal-sdk.yaml
+    filter: all
+
+
+
Local lensesContent hashes are calculated automatically.
+
Remote lensesHTTPS and an expected SHA-256 are required.
+
+
+
+

Make CCE speak your language

+

Your code has its own vocabulary. A lens teaches CCE to recognize it.

+

A lens is a small YAML file that describes the libraries or patterns you want to find. Use one to inventory internal SDKs, legacy clients, or technology-debt patterns alongside built-in cloud mappings.

+
    +
  • Keep lens definitions with your code.
  • +
  • Pin remote content so changes are visible.
  • +
  • Test changes against fixtures before rollout.
  • +
+ Read the plain-language lens guide +
+
+
+ +
+
+
+

Designed for responsible review

+

Useful evidence. Clear boundaries.

+

CCE supports engineering decisions; it does not replace testing, provider documentation, or an IAM reviewer.

+
+
+

Private by default

No CCE account is needed. Field diagnostics are off unless you explicitly enable them. Basic scans use read-only repository permissions.

+

Traceable results

Reports connect operations to source locations. Lens hashes and versioned artifacts help reviewers understand what produced a result.

+

No guessed permissions

Strict GCP and Azure exports do not publish unverified permission mappings. A missing role export is not silently replaced with a guess.

+

Static-analysis limits

Dynamic, reflected, or unrecognized wrapped calls may be missed. An empty result does not prove that a service needs no permissions.

+
+
+ IAM requests are review input, not ready-to-deploy policy. +

CCE identifies operations in source code. Your reviewers remain responsible for resource scope, runtime behavior, organizational policy, and final approval.

+
+
+
+ +
+
+
+

Good to know

+

Practical details

+
+
Runner
Linux with Docker; ubuntu-latest is the simplest choice.
+
Languages
Go, Python, Java, and JavaScript. Use AUTO for detection.
+
Results
JSON reports, workflow artifacts, optional HTML and SARIF, and selected IAM exports.
+
Custom providers
Use filter: all when a lens reports categories outside the cloud filter.
+
Large repositories
Scan a subdirectory or set scan-timeout to keep CI bounded.
+
Fork pull requests
Review artifacts remain available; comments and SARIF publication are skipped when the token cannot write safely.
+
+
+
+

Common questions

+
+ Do I need to install CCE separately? +

No. The reusable workflows and composite actions provide a tested CCE version for the run.

+
+
+ Can I use CCE inside an existing job? +

Yes. Check out your repository, then use stackgenhq/cce-action@v1 or a focused subaction such as access-request@v1.

+
+
+ Where do my reports go? +

They are written to the configured output directory and, in the reusable workflows, uploaded as GitHub Actions artifacts.

+
+
+ Is this a compliance or least-privilege verdict? +

No. It is source-code evidence for review. Validate policies against runtime needs and your organization’s requirements.

+
+
+
+
+ +
+
+
+

Start with one repository

+

Make cloud usage easier to see, share, and review.

+
+ +
+
+
+ + + +