Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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
Expand Down
Empty file added docs/.nojekyll
Empty file.
28 changes: 28 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# CCE Action developer site

This directory is the complete static site published at
<https://stackgenhq.github.io/cce-action/>. 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 <http://localhost:8000>.

## 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.
Loading
Loading