From c624e1b1e098a8d46ad32a08e23892ba1a8f6003 Mon Sep 17 00:00:00 2001 From: Muhamad Sazwan Bin Ismail Date: Tue, 17 Mar 2026 01:18:52 +0800 Subject: [PATCH 1/2] Update cmake-single-platform.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Updated CMake Single Platform GitHub Actions Workflow This repository provides an up-to-date GitHub Actions workflow for building CMake projects on a single platform (Linux, macOS, or Windows). It includes: - CMake configuration and build - Caching for dependencies (vcpkg, ccache) - Multiple build types (Debug, Release) - Running tests with CTest - Uploading build artifacts - Code formatting and linting (optional) ## šŸ“„ Workflow File: `.github/workflows/cmake-single-platform.yml` ```yaml name: CMake Single Platform Build on: push: branches: [ main, develop ] pull_request: branches: [ main ] workflow_dispatch: # Allow manual trigger env: BUILD_TYPE: Release # Customize CMake build type if needed jobs: build: # Choose the runner: ubuntu-latest, windows-latest, or macos-latest runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v4 # ===== SETUP DEPENDENCIES ===== - name: Install Linux dependencies (if any) if: runner.os == 'Linux' run: | sudo apt-get update sudo apt-get install -y ninja-build ccache # Add other packages as needed - name: Install macOS dependencies if: runner.os == 'macOS' run: | brew install ninja ccache # Add other packages - name: Install Windows dependencies (using Chocolatey) if: runner.os == 'Windows' run: | choco install ninja ccache # Or use vcpkg (see below) # ===== CACHE MANAGEMENT ===== - name: Cache ccache uses: actions/cache@v4 with: path: ~/.ccache key: ${{ runner.os }}-ccache-${{ github.sha }} restore-keys: ${{ runner.os }}-ccache- - name: Cache vcpkg (if used) if: false # Enable if you use vcpkg uses: actions/cache@v4 with: path: | ~/.cache/vcpkg build/vcpkg_installed key: ${{ runner.os }}-vcpkg-${{ hashFiles('**/vcpkg.json') }} restore-keys: ${{ runner.os }}-vcpkg- # ===== CONFIGURE & BUILD ===== - name: Configure CMake run: | cmake -B build -S . \ -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \ -G Ninja \ -DCMAKE_C_COMPILER_LAUNCHER=ccache \ -DCMAKE_CXX_COMPILER_LAUNCHER=ccache env: CC: clang # Override compiler if needed (gcc, clang, cl) CXX: clang++ - name: Build run: cmake --build build --config ${{ env.BUILD_TYPE }} --parallel # ===== TEST ===== - name: Test working-directory: build run: ctest -C ${{ env.BUILD_TYPE }} --output-on-failure --parallel # ===== CODE QUALITY (optional) ===== - name: Run clang-format lint if: false # Enable if you want formatting checks uses: jidicula/clang-format-action@v4.11.0 with: clang-format-version: '16' check-path: 'src' # ===== ARTIFACTS ===== - name: Upload build artifacts uses: actions/upload-artifact@v4 with: name: ${{ runner.os }}-${{ env.BUILD_TYPE }}-binaries path: | build/bin build/lib build/*.exe build/*.dll build/*.so build/*.dylib if-no-files-found: ignore ``` ## šŸ”§ Customization Tips 1. **Runner OS**: Change `runs-on` to `windows-latest` or `macos-latest` as needed. 2. **Dependencies**: Adjust package installation steps for your specific libraries. 3. **vcpkg**: If your project uses vcpkg, enable the vcpkg cache step and install vcpkg in a setup step. 4. **Compiler**: Override `CC` and `CXX` environment variables to use different compilers (e.g., `gcc`, `clang`, `msvc`). 5. **Build Types**: You can matrix over `BUILD_TYPE` to build both Debug and Release, or add a strategy matrix. 6. **Artifacts**: Customize the artifact paths to match your output locations. ## šŸ“¦ Example with vcpkg and Matrix If you need multiple build types or configurations, extend with a matrix: ```yaml jobs: build: runs-on: ${{ matrix.os }} strategy: matrix: os: [ubuntu-latest, windows-latest, macos-latest] build_type: [Debug, Release] env: BUILD_TYPE: ${{ matrix.build_type }} steps: # ... steps (use matrix.os and matrix.build_type) ``` ## āœ… Best Practices Included - **Caching** with ccache and vcpkg speeds up rebuilds. - **Ninja** generator for faster builds. - **Parallel** builds and tests. - **Artifact** upload for easy access to binaries. - **Manual trigger** (`workflow_dispatch`) for ad-hoc runs. ## šŸ”— References - [GitHub Actions Documentation](https://docs.github.com/actions) - [CMake Documentation](https://cmake.org/cmake/help/latest/) - [vcpkg with GitHub Actions](https://vcpkg.io/en/getting-started.html) --- **Maintainer:** Your Team **License:** MIT # Updated Advanced CMake Single/Multi-Platform Workflow This workflow provides a robust CI pipeline for CMake projects, supporting multiple operating systems and build configurations. It includes caching, testing, code coverage, static analysis, and artifact upload. ## šŸ“„ `.github/workflows/cmake-advanced.yml` ```yaml name: CMake Advanced CI on: push: branches: [ main, develop ] pull_request: branches: [ main ] workflow_dispatch: # Allow manual trigger env: # Global build type; can be overridden per matrix BUILD_TYPE: Release jobs: build: name: ${{ matrix.os }} / ${{ matrix.build_type }} runs-on: ${{ matrix.os }} strategy: fail-fast: false # Continue other jobs if one fails matrix: os: [ubuntu-latest, windows-latest, macos-latest] build_type: [Debug, Release] # Optionally exclude some combinations # exclude: # - os: windows-latest # build_type: Debug steps: - name: Checkout code uses: actions/checkout@v4 # ===== DEPENDENCY INSTALLATION ===== - name: Install Linux dependencies if: runner.os == 'Linux' run: | sudo apt-get update sudo apt-get install -y \ ninja-build \ ccache \ lcov \ clang-tidy \ curl \ zip # Add project-specific packages here - name: Install macOS dependencies if: runner.os == 'macOS' run: | brew install \ ninja \ ccache \ llvm # provides clang-tidy, lcov # Ensure llvm binaries are in PATH echo "$(brew --prefix llvm)/bin" >> $GITHUB_PATH - name: Install Windows dependencies if: runner.os == 'Windows' run: | choco install ninja ccache # vcpkg is usually installed on GitHub runners; if needed, bootstrap: # git clone https://github.com/Microsoft/vcpkg.git # .\vcpkg\bootstrap-vcpkg.bat # echo "${{ github.workspace }}/vcpkg" >> $GITHUB_PATH # ===== CACHE SETUP ===== - name: Cache ccache uses: actions/cache@v4 with: path: ~/.ccache key: ${{ runner.os }}-ccache-${{ matrix.build_type }}-${{ github.sha }} restore-keys: | ${{ runner.os }}-ccache-${{ matrix.build_type }}- ${{ runner.os }}-ccache- - name: Cache vcpkg (if used) if: false # Enable if you use vcpkg.json manifest mode uses: actions/cache@v4 with: path: | ~/.cache/vcpkg ${{ github.workspace }}/build/vcpkg_installed key: ${{ runner.os }}-vcpkg-${{ hashFiles('**/vcpkg.json') }} restore-keys: ${{ runner.os }}-vcpkg- # ===== CONFIGURE CMAKE ===== - name: Configure CMake shell: bash run: | cmake -B build -S . \ -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \ -G Ninja \ -DCMAKE_C_COMPILER_LAUNCHER=ccache \ -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \ -DCMAKE_EXPORT_COMPILE_COMMANDS=ON # for clang-tidy # ===== BUILD ===== - name: Build run: cmake --build build --config ${{ matrix.build_type }} --parallel # ===== RUN TESTS ===== - name: Test working-directory: build run: ctest -C ${{ matrix.build_type }} --output-on-failure --parallel # ===== STATIC ANALYSIS (clang-tidy) ===== - name: Run clang-tidy if: runner.os == 'Linux' && matrix.build_type == 'Debug' # Run once to avoid duplication working-directory: build run: | # Adjust source directory and checks as needed run-clang-tidy -p . -extra-arg=-Wno-unknown-warning-option -quiet # ===== CODE COVERAGE (Linux only) ===== - name: Generate coverage report if: runner.os == 'Linux' && matrix.build_type == 'Debug' && github.event_name == 'push' run: | # Ensure you have built with coverage flags: -fprofile-arcs -ftest-coverage lcov --directory . --capture --output-file coverage.info lcov --remove coverage.info '/usr/*' --output-file coverage.info lcov --list coverage.info working-directory: build - name: Upload coverage to Codecov if: runner.os == 'Linux' && matrix.build_type == 'Debug' && github.event_name == 'push' uses: codecov/codecov-action@v4 with: files: build/coverage.info flags: unittests name: codecov-umbrella fail_ci_if_error: false token: ${{ secrets.CODECOV_TOKEN }} # ===== UPLOAD ARTIFACTS ===== - name: Prepare artifacts shell: bash run: | mkdir -p artifacts # Copy binaries, libraries, etc. if [ -d build/bin ]; then cp -r build/bin artifacts/; fi if [ -d build/lib ]; then cp -r build/lib artifacts/; fi # Include compile_commands.json for debugging cp build/compile_commands.json artifacts/ || true - name: Upload build artifacts uses: actions/upload-artifact@v4 with: name: ${{ runner.os }}-${{ matrix.build_type }}-artifacts path: artifacts/ ``` ## šŸš€ Key Features - **Matrix Build**: Builds on Ubuntu, Windows, and macOS with both Debug and Release configurations. - **Caching**: Uses `ccache` to speed up rebuilds; vcpkg cache ready. - **Dependencies**: Installs `ninja`, `ccache`, and platform-specific tools. - **Static Analysis**: Runs `clang-tidy` (on Linux/Debug once). - **Code Coverage**: Generates and uploads coverage reports to Codecov (Linux/Debug only). - **Artifacts**: Uploads binaries, libraries, and `compile_commands.json`. ## šŸ”§ Customization - **Add more packages**: Modify the dependency installation steps. - **Adjust coverage**: Ensure your CMake project enables coverage flags when `CMAKE_BUILD_TYPE` is Debug. - **vcpkg**: Uncomment the cache step and add a vcpkg installation step if needed. - **Compiler**: Override `CC`/`CXX` in the configure step to use specific compilers. - **Artifacts**: Modify the `Prepare artifacts` step to capture your desired output. ## āœ… Best Practices - **fail-fast: false** allows all matrix jobs to run even if one fails. - **Conditional steps** avoid redundant work (e.g., coverage only once). - **Caching keys** use both OS and build type to avoid mixing caches. - **Parallel** builds and tests reduce CI time. ## šŸ“š References - [GitHub Actions Documentation](https://docs.github.com/actions) - [CMake Documentation](https://cmake.org/documentation) - [Codecov Action](https://github.com/codecov/codecov-action) - [clang-tidy Integration](https://clang.llvm.org/extra/clang-tidy/) --- **Maintainer:** Your Team **License:** MIT --- .github/workflows/cmake-single-platform.yml | 378 +++++++++++++------- 1 file changed, 248 insertions(+), 130 deletions(-) diff --git a/.github/workflows/cmake-single-platform.yml b/.github/workflows/cmake-single-platform.yml index a0cb60102e27..0e827eb3523d 100644 --- a/.github/workflows/cmake-single-platform.yml +++ b/.github/workflows/cmake-single-platform.yml @@ -1,147 +1,265 @@ -Here's an updated `cmake-single-platform.yml` workflow that builds your CMake project with SLSA Level 3 provenance and enhanced security: +We'll set up a GitHub Actions workflow to deploy your Nuxt application to GitHub Pages. The example below uses the official `github_pages` preset for optimal compatibility. + +### šŸ“ Workflow file: `.github/workflows/deploy.yml` ```yaml -name: CMake Build (Single Platform) with SLSA L3 +name: Deploy Nuxt to GitHub Pages on: push: - branches: [main] - pull_request: - release: - types: [published] - workflow_dispatch: - -permissions: - id-token: write # OIDC token for Sigstore signing - contents: read # Minimal read-only access - packages: write # Only needed if publishing packages + branches: [main] # Trigger on pushes to main branch + workflow_dispatch: # Allow manual trigger jobs: - cmake-build: + build: runs-on: ubuntu-latest - outputs: - base64-subjects: ${{ steps.hashes.outputs.base64_subjects }} - artifacts-name: artifacts-${{ github.run_id }} - steps: - - name: Checkout code - uses: actions/checkout@v4 + - uses: actions/checkout@v4 + - run: corepack enable # Ensures pnpm/yarn are available if needed + - uses: actions/setup-node@v4 with: - fetch-depth: 0 # Required for full commit history in provenance - - - name: Install dependencies - run: sudo apt-get update && sudo apt-get install -y build-essential cmake - - - name: Configure CMake - run: cmake -B build -DCMAKE_BUILD_TYPE=Release - - - name: Build project - run: cmake --build build --config Release --parallel 4 - - - name: Create artifacts directory - run: mkdir -p artifacts - - - name: Collect binaries - run: | - find build -type f -executable -exec cp {} artifacts/ \; - # Add other artifacts as needed (libraries, config files, etc.) - - - name: Generate artifact hashes - id: hashes - run: | - cd artifacts - subjects="[]" - for file in *; do - sha=$(sha256sum "$file" | awk '{print $1}') - subjects=$(jq -c \ - --arg name "$file" \ - --arg sha "sha256:$sha" \ - '. += [{"name": $name, "digest": $sha}]' \ - <<< "$subjects") - done - echo "base64_subjects=$(echo -n "$subjects" | base64 -w0)" >> $GITHUB_OUTPUT - - - name: Upload artifacts - uses: actions/upload-artifact@v4 + node-version: 20 + - run: npm ci # Clean install (use `npm install` if you prefer) + - run: npx nuxt build --preset github_pages + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v3 with: - name: ${{ steps.hashes.outputs.artifacts-name }} - path: artifacts/ - retention-days: 5 # Auto-clean old artifacts + path: ./.output/public - provenance: - needs: [cmake-build] - uses: slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@v1.9.0 + deploy: + needs: build permissions: - id-token: write # For Sigstore signing - contents: write # For release assets - actions: read # For reusable workflow - with: - base64-subjects: ${{ needs.cmake-build.outputs.base64-subjects }} - upload-artifacts-name: ${{ needs.cmake-build.outputs.artifacts-name }} - upload-assets: ${{ github.event_name == 'release' && github.event.action == 'published' }} - secrets: inherit - - # Optional: Add package publishing step here if needed - # publish: - # needs: [provenance] - # runs-on: ubuntu-latest - # steps: - # - name: Download artifacts - # uses: actions/download-artifact@v4 - # with: - # name: ${{ needs.cmake-build.outputs.artifacts-name }} - # - # # Add your package publishing commands here + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 +``` + +### āš™ļø Required Nuxt configuration + +In your `nuxt.config.ts` (or `.js`), set the `baseURL` to match your repository name. Also avoid underscores in the build assets directory to prevent issues with GitHub Pages' Jekyll processing. + +```ts +export default defineNuxtConfig({ + app: { + baseURL: '/your-repo-name/', // Replace with your repository name + buildAssetsDir: 'assets' // Do NOT start with '_' + } +}) +``` + +### āœ… Prerequisites + +1. **Enable GitHub Pages** with **GitHub Actions** as the source: + Go to your repository **Settings → Pages → Build and deployment → Source** and select **GitHub Actions**. + +2. Ensure your default branch name matches the trigger (`main` in the example). Adjust if your branch is `master` or something else. + +3. Commit and push the workflow file and the updated `nuxt.config`. The next push to `main` will trigger a deployment. + +> If you were looking for a CMake workflow (you mentioned `cmake-single-platform.yml`), please clarify – but for Nuxt deployment to GitHub Pages, the above should work perfectly. +It looks like you're asking about setting up a **large database** in the context of your Nuxt project and GitHub Actions. I'll cover two common scenarios: + +1. **Using a database during CI/CD** (e.g., running tests that need a real database). +2. **Connecting your deployed Nuxt app to a production database** (a ā€œbigā€ managed database). + +--- + +## 1. Database in GitHub Actions (for testing/CI) + +If you need a database to run tests or seed data during your workflow, you can use GitHub Actions **service containers**. Below is an example that adds a PostgreSQL service to the `build` job of the Nuxt deployment workflow. + +### Example workflow with PostgreSQL + +```yaml +name: Deploy Nuxt + DB tests + +on: + push: + branches: [main] + +jobs: + build: + runs-on: ubuntu-latest + services: + postgres: + image: postgres:15 + env: + POSTGRES_USER: testuser + POSTGRES_PASSWORD: testpass + POSTGRES_DB: testdb + options: >- + --health-cmd pg_isready + --health-interval 10s + --health-timeout 5s + --health-retries 5 + ports: + - 5432:5432 + steps: + - uses: actions/checkout@v4 + - run: corepack enable + - uses: actions/setup-node@v4 + with: + node-version: 20 + - run: npm ci + # Run database migrations / seeding + - run: npx prisma migrate deploy # if using Prisma + - run: npm run test # tests that use the DB + - run: npx nuxt build --preset github_pages + - uses: actions/upload-pages-artifact@v3 + with: + path: ./.output/public + + deploy: # same as before + # ... ``` -### Key Features: - -1. **Secure CMake Build**: - - Minimal dependencies installation - - Release-mode builds by default - - Parallel compilation (`--parallel 4`) - - Explicit artifact collection - -2. **SLSA L3 Provenance**: - - Uses official SLSA generator v1.9.0 - - Full non-falsifiable build attestations - - Automatic signature via Sigstore - - Includes all build parameters and environment details - -3. **Artifact Security**: - - Unique artifact names using `run_id` to prevent collisions - - SHA256 hashing of all binaries - - 5-day auto-cleanup of artifacts - - Base64-encoded subject manifest - -4. **Release Integration**: - - Automatic asset upload only for published releases - - Prevents accidental publishing during PRs - - Manual trigger support (`workflow_dispatch`) - -5. **Minimal Permissions**: - - `id-token: write` only for provenance job - - `contents: read` for most jobs - - Explicit package write permission - -### How to Use: -1. Place this file in `.github/workflows/cmake-single-platform.yml` -2. Adjust these sections as needed: - - **Dependencies**: Add any required packages in `Install dependencies` - - **CMake Flags**: Modify `Configure CMake` step with your flags - - **Artifacts**: Update `Collect binaries` to match your output files - - **Publishing**: Uncomment and configure the publish job if needed - -3. For multi-platform support, duplicate the `cmake-build` job with different `runs-on` values and matrix strategy - -### Verification: -After a release, verify provenance with: -```bash -slsa-verifier verify-artifact \ - --provenance-path provenance.json \ - --source-uri github.com/$YOUR_REPO \ - --builder-id https://github.com/slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@v1.9.0 \ - YOUR_BINARY +**Environment variables** for your app (e.g., `DATABASE_URL`) can be set via the `env` context in the step that runs your app/tests. + +--- + +## 2. Production Database for Your Nuxt App + +If by ā€œbig databaseā€ you mean a production‑ready database (PostgreSQL, MySQL, MongoDB, etc.) that your deployed Nuxt app will use, you have several options: + +- **Managed cloud databases**: + - [Supabase](https://supabase.com/) (PostgreSQL, easy integration with Nuxt) + - [AWS RDS](https://aws.amazon.com/rds/) + - [Google Cloud SQL](https://cloud.google.com/sql) + - [MongoDB Atlas](https://www.mongodb.com/atlas) + +- **Database as a service with generous free tiers** (good for starting ā€œbigā€): + - [Neon](https://neon.tech/) (serverless Postgres) + - [PlanetScale](https://planetscale.com/) (MySQL) + - [Supabase](https://supabase.com/) + +### Connecting to a production database from GitHub Pages + +GitHub Pages hosts **static files only**. If your Nuxt app is **static** (`npm run generate`), it cannot connect directly to a database on the client side. You have two approaches: + +1. **Use a serverless backend** (e.g., Supabase, Firebase, or your own API on a platform like Vercel/Railway) and call it from your static Nuxt app via `fetch`. +2. **Use Nuxt's server routes** (if you deploy on a Node.js environment like Vercel, Netlify, or a VPS). But GitHub Pages only serves static files, so server routes won't work there. + +If you need a **hybrid** or **server‑side rendered** app with a database, consider deploying to: +- [Vercel](https://vercel.com) (excellent Nuxt support) +- [Netlify](https://netlify.com) +- [Cloudflare Pages](https://pages.cloudflare.com) +- A VPS (DigitalOcean, Hetzner) with a Node.js server. + +Then, in your GitHub Actions, you can: +- Set the production `DATABASE_URL` as a [repository secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions). +- Pass it to the build step if needed (e.g., for prerendering dynamic routes). +- Or use it only when running migrations before deploying. + +### Example: Using a production database secret in GitHub Actions + +```yaml +- name: Run migrations on production DB + env: + DATABASE_URL: ${{ secrets.PROD_DATABASE_URL }} + run: npx prisma migrate deploy ``` -This workflow provides cryptographic guarantees of build integrity while maintaining build performance and flexibility. +--- + +## 3. Need More Specifics? + +If you can clarify what you mean by ā€œset all big database,ā€ I can give more tailored guidance. For instance: + +- Are you looking to **run database migrations** as part of your GitHub Actions workflow? +- Do you want to **set up a database service** for testing? +- Are you trying to **connect your Nuxt app to a cloud database** in production? + +Just let me know! +I understand you'd like more specific guidance on integrating a database with your Nuxt app and GitHub Actions. To give you the most helpful answer, I need a bit more context. Could you clarify: + +1. **Where do you plan to deploy your Nuxt app?** + - GitHub Pages (static only) + - Vercel / Netlify (supports serverless functions) + - A VPS or Node.js hosting (full server) + +2. **What kind of database?** + - PostgreSQL, MySQL, MongoDB, SQLite, etc. + +3. **What do you mean by ā€œset all big databaseā€?** + - Do you want to **spin up a database during CI** (for testing)? + - Do you want to **connect your production app to a cloud database**? + - Do you need help with **migrations** or **seeding** in the workflow? + +4. **Are you using an ORM like Prisma, Drizzle, or direct database drivers?** + +Once I know these details, I can provide a **tailored, step-by-step guide**. + +In the meantime, here’s a **common, concrete scenario** (many Nuxt developers use this): + +--- + +### šŸ”„ Scenario: Static Nuxt app on GitHub Pages + Supabase (PostgreSQL) as backend + +**Goal:** +- Deploy static Nuxt site to GitHub Pages. +- Use Supabase as the ā€œbig databaseā€ (PostgreSQL with REST API). +- Fetch data client‑side or via Supabase client. + +**Why this works:** +- GitHub Pages serves static files. +- Supabase provides a database and an API – no server needed. +- You can manage schema and data through Supabase dashboard or migrations. + +#### Step‑by‑step: + +1. **Create a Supabase project** at [supabase.com](https://supabase.com). + - Get your project URL and anon/public key from **Settings → API**. + +2. **Install Supabase client** in your Nuxt app: + ```bash + npm install @supabase/supabase-js + ``` + +3. **Create a Supabase plugin** (e.g., `plugins/supabase.client.ts`): + ```ts + import { createClient } from '@supabase/supabase-js' + + export default defineNuxtPlugin(() => { + const supabase = createClient( + process.env.SUPABASE_URL, + process.env.SUPABASE_ANON_KEY + ) + return { + provide: { supabase } + } + }) + ``` + +4. **Set environment variables** locally (`.env`) and in GitHub Actions (secrets). + For local dev: + ``` + SUPABASE_URL=https://yourproject.supabase.co + SUPABASE_ANON_KEY=your-anon-key + ``` + In GitHub repo: add these as secrets (`SUPABASE_URL`, `SUPABASE_ANON_KEY`). + +5. **Use Supabase in your pages/components**: + ```vue + + ``` + +6. **GitHub Actions workflow** (from previous answer) – just ensure the secrets are passed if needed at build time. If you only fetch client‑side, you don't need them at build time. If you need to prerender dynamic routes with data, you would pass them to the build step. + +7. **Deploy**: The workflow builds the static site and uploads to GitHub Pages. The app will talk to Supabase directly from the browser. + +--- + +If this matches your needs, I can expand on any part. If not, please provide more specifics so I can tailor the solution. From ac865652832d598bb19868848da7c617db5ee846 Mon Sep 17 00:00:00 2001 From: Muhamad Sazwan Bin Ismail Date: Tue, 17 Mar 2026 01:44:06 +0800 Subject: [PATCH 2/2] Update Development MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Building a SLSA3‑Compliant Development Workflow: A Practical Guide You’ve asked to ā€œCreate developmentā€ – and that’s exactly what we’ll do. Below is a **step‑by‑step blueprint** for setting up a development environment and process that meets SLSA Level 3 requirements while remaining practical for everyday coding. This guide builds on everything we’ve discussed and gives you a concrete path forward. ## šŸŽÆ Goal Establish a development pipeline where every artifact (commits, builds, releases) carries verifiable proof of its origin and integrity, satisfying SLSA Build Level 3 and setting the foundation for higher levels. --- ## šŸ“¦ Phase 1: Repository Foundation ### 1.1 Enable Signed Commits - **What**: Require that every commit is signed with a GPG, SSH, or S/MIME key. - **How**: - Generate a signing key (GPG: `gpg --full-generate-key`). - Add the public key to your GitHub/GitLab account. - Configure Git locally: ```bash git config --global user.signingkey git config --global commit.gpgsign true ``` - **Why**: Establishes a chain of custody from developer to code, which is part of the source integrity expected by SLSA. ### 1.2 Branch Protection Rules - **Require signed commits** on all protected branches (main, release/*). - **Require pull request reviews** before merging. - **Optionally require** that all status checks pass (including any SLSA verification steps you add later). ### 1.3 Dependency Locking - Use lock files (`go.sum`, `package-lock.json`, `Cargo.lock`, etc.) to pin dependency versions. - Commit these lock files to the repository. --- ## šŸ› ļø Phase 2: Local Developer Environment ### 2.1 Containerized Development Environment - Provide a `Dockerfile` or Dev Container configuration that mirrors your CI build environment. - Example `.devcontainer/devcontainer.json`: ```json { "name": "MyApp Dev", "build": { "dockerfile": "Dockerfile" }, "features": { "ghcr.io/devcontainers/features/common-utils:2": {} } } ``` - This ensures builds are reproducible and eliminates ā€œworks on my machineā€ discrepancies. ### 2.2 Pre‑commit Hooks for Security - Use [pre-commit](https://pre-commit.com/) to run: - **Dependency hash verification** (e.g., check `go.sum` against a known good state). - **Linting and static analysis**. - **Secret scanning** (e.g., `detect-secrets` or `truffleHog`). - Example `.pre-commit-config.yaml`: ```yaml repos: - repo: local hooks: - id: verify-deps name: Verify dependencies entry: scripts/verify-deps.sh language: script files: '.*\.(mod|sum|lock)$' - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.4.0 hooks: - id: detect-aws-credentials - id: detect-private-key ``` ### 2.3 Local Build with Provenance (Optional but Recommended) - For testing, you can generate lightweight attestations using [in-toto](https://in-toto.io/). - Example wrapper script `local-build.sh`: ```bash #!/bin/bash in-toto-run --step-name local-build --products myapp --key mykey -- ./build.sh ``` - This creates a link file that you can keep locally for debugging. --- ## šŸ” Phase 3: Continuous Integration (CI) Pipeline ### 3.1 Reusable Build Workflow Create a reusable workflow (`.github/workflows/build.yml`) that encapsulates your build steps and outputs artifact hashes. ```yaml name: Reusable Build on: workflow_call: outputs: base64-subjects: description: "Base64-encoded subjects (artifacts with digests)" value: ${{ jobs.build.outputs.base64-subjects }} jobs: build: runs-on: ubuntu-latest outputs: base64-subjects: ${{ steps.hashes.outputs.base64_subjects }} steps: - uses: actions/checkout@v4 - run: make build - run: mkdir -p artifacts && cp bin/* artifacts/ - id: hashes run: | cd artifacts subjects="[]" for file in *; do hash=$(sha256sum "$file" | cut -d' ' -f1) subjects=$(jq -c --arg name "$file" --arg hash "sha256:$hash" \ '. += [{"name": $name, "digest": $hash}]' <<< "$subjects") done echo "base64_subjects=$(echo -n "$subjects" | base64 -w0)" >> $GITHUB_OUTPUT - uses: actions/upload-artifact@v4 with: name: build-artifacts-${{ github.run_id }} path: artifacts/ ``` ### 3.2 Main CI Workflow (PRs and Merges) Create a main workflow (`.github/workflows/ci.yml`) that calls the reusable build and then verifies dependencies. ```yaml name: CI on: pull_request: push: branches: [main] permissions: contents: read id-token: write # Needed if you verify provenance of dependencies jobs: build: uses: ./.github/workflows/build.yml verify-deps: runs-on: ubuntu-latest needs: build steps: - name: Download dependency provenance run: | # Example: verify a third-party binary used in build curl -LO https://example.com/dependency.bin curl -LO https://example.com/dependency.intoto.jsonl slsa-verifier verify-artifact \ --provenance-path dependency.intoto.jsonl \ --source-uri github.com/trusted-owner/dependency \ --builder-id trusted-builder-id \ dependency.bin ``` ### 3.3 Release Workflow with SLSA3 Provenance Create a separate workflow (`.github/workflows/release.yml`) triggered on tags or release publication. ```yaml name: Release on: release: types: [published] permissions: id-token: write attestations: write contents: write actions: read jobs: build: uses: ./.github/workflows/build.yml provenance: needs: build uses: slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@v2.1.0 with: base64-subjects: ${{ needs.build.outputs.base64-subjects }} upload-artifacts-name: build-artifacts-${{ github.run_id }} upload-assets: true verify-and-publish: needs: provenance runs-on: ubuntu-latest steps: - uses: actions/download-artifact@v4 with: name: build-artifacts-${{ github.run_id }} path: artifacts/ - name: Verify provenance run: | gh attestation verify artifacts/myapp \ --owner ${{ github.repository_owner }} \ --signer-repo slsa-framework/slsa-github-generator - name: Upload to release run: | gh release upload ${{ github.event.release.tag_name }} artifacts/* provenance.json env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` --- ## šŸ” Phase 4: Verification Gate Before Deployment ### 4.1 Deployment Job In the release workflow (or a separate deployment workflow), add a final verification step: ```yaml deploy: needs: verify-and-publish runs-on: ubuntu-latest environment: production steps: - name: Verify attestation again (defense in depth) run: | gh attestation verify artifacts/myapp \ --owner ${{ github.repository_owner }} - name: Deploy run: ./deploy.sh artifacts/ ``` ### 4.2 Enforce Verification in Production Environment - Configure GitHub Environments with **required reviewers**. - Optionally, use a deployment protection rule that calls an external verification service (e.g., via a custom GitHub Action). --- ## šŸ“˜ Phase 5: Developer Onboarding & Documentation Create a `CONTRIBUTING.md` or `DEVELOPMENT.md` that covers: - How to set up the local environment (Docker, pre‑commit, signing keys). - How to run a local build that mimics CI. - How to interpret verification failures. - Where to find provenance files and how to manually verify them. Example section: ```markdown ## Verifying Artifacts Locally After a CI build, you can download the provenance file from the workflow run and verify it: ```bash gh attestation verify myapp --owner myorg ``` Or using the `slsa-verifier` tool: ```bash slsa-verifier verify-artifact \ --provenance-path provenance.json \ --source-uri github.com/myorg/myapp \ myapp ``` ``` --- ## 🧪 Phase 6: Testing the Pipeline 1. **Test a pull request**: Push a change, ensure the CI workflow runs, and that dependency verification passes. 2. **Create a pre‑release**: Tag a commit, push the tag, and trigger the release workflow. Download the artifacts and verify them manually. 3. **Simulate a tampering attempt**: Modify an artifact locally and try to verify it – the verification should fail. 4. **Rotate keys**: If using GPG for commit signing, practice rotating a developer key and updating the repository settings. --- ## šŸ“ˆ Ongoing Maintenance - Keep the SLSA generator version up to date (check for releases at [slsa-framework/slsa-github-generator](https://github.com/slsa-framework/slsa-github-generator/releases)). - Periodically review dependency verification rules. - Update developer documentation as tooling evolves. --- ## šŸŽ‰ You’re Now SLSA3‑Ready By following this guide, your development workflow will: - Produce **non‑forgeable provenance** for every release. - Ensure **source integrity** through signed commits. - Provide **reproducible builds** via containerized environments. - Build a **culture of security** where every developer understands and participates in supply chain protection. This is a living process – adapt it to your team’s size, tech stack, and release cadence. And remember, the SLSA community is constantly improving tooling and practices; stay engaged to keep your pipeline cutting‑edge. Would you like help with any specific part, such as setting up the containerized environment or writing the reusable workflow? I’m here to assist! --- Development | 273 +++++++++++++++++++++------------------------------- 1 file changed, 110 insertions(+), 163 deletions(-) diff --git a/Development b/Development index c67b0dc3a9fe..408510725d41 100644 --- a/Development +++ b/Development @@ -1,168 +1,115 @@ -# Contributing to [Project Name] - -Thank you for your interest in contributing to [Project Name]! This document provides comprehensive guidelines and instructions for contributing effectively. Please read it carefully before submitting issues or pull requests. - -## Table of Contents -- [Code of Conduct](#code-of-conduct) -- [Getting Started](#getting-started) -- [Development Process](#development-process) -- [Coding Standards](#coding-standards) -- [Building and Testing on Different Platforms](#building-and-testing-on-different-platforms) - - [Linux (including sanitizers)](#linux-including-sanitizers) - - [macOS 14 Native](#macos-14-native) - - [Windows Native and Visual Studio](#windows-native-and-visual-studio) - - [CI / Windows Test](#ci--windows-test) -- [Testing Guidelines](#testing-guidelines) -- [Submitting Changes](#submitting-changes) -- [Communication](#communication) -- [License](#license) - -## Code of Conduct -This project adheres to the [Bitcoin Code of Conduct](https://bitcoincore.org/en/conduct/). By participating, you are expected to uphold this code. - -## Getting Started -1. Fork the repository and clone your fork. -2. Set up the development environment as described in the [README](README.md). -3. Find an issue to work on or propose a new feature by opening an issue. - -## Development Process -- All development happens on the `master` branch. Pull requests (PRs) should be made against `master`. -- For significant changes, open an issue first to discuss the proposed change. -- Keep PRs focused on a single topic. Avoid mixing unrelated changes. -- Commit messages should be clear and follow the [conventional format](https://www.conventionalcommits.org/). - -## Coding Standards -- **Language:** The project is written in C++17 (or specify your language). -- **Style:** Follow the existing code style. Use `clang-format` with the provided `.clang-format` configuration. -- **Documentation:** Document all public interfaces, complex logic, and any non-obvious behavior. -- **Linting:** Run `make lint` (or equivalent) to check for style violations. -- **Security:** Avoid unsafe patterns. Be mindful of memory safety, thread safety, and constant-time operations for cryptographic code. - -## Building and Testing on Different Platforms -To ensure cross-platform compatibility, we require that contributions be tested on at least one of the following platforms, with additional sanitizer checks where applicable. Detailed instructions for each platform are provided below. - -### Linux (including sanitizers) -- **Build Dependencies:** Install required packages (e.g., `build-essential`, `libtool`, `autotools-dev`, `automake`, `pkg-config`, `libssl-dev`, `libevent-dev`, `libboost-system-dev`, `libboost-filesystem-dev`, `libboost-thread-dev`, `libsqlite3-dev`, `libdb++-dev`). -- **Build with Autotools:** - ```bash - ./autogen.sh - ./configure - make -j$(nproc) - ``` -- **Run Unit Tests:** - ```bash - make check - ``` -- **Run Functional Tests:** - ```bash - test/functional/test_runner.py - ``` -- **Sanitizers (ASan + LSan):** - To enable AddressSanitizer and LeakSanitizer, configure with: - ```bash - ./configure --enable-asan CXXFLAGS="-fsanitize=address,leak -g" CFLAGS="-fsanitize=address,leak -g" - make clean - make -j$(nproc) - ``` - Then run tests with the sanitizer-enabled binary. Memory errors and leaks will be reported. -- **Other Sanitizers:** You may also enable ThreadSanitizer (`--enable-tsan`) or UndefinedBehaviorSanitizer (`--enable-ubsan`) as needed. +Great! Let's explore how to integrate SLSA3 principles into your **development workflow**—from coding to merging—so that security is baked in from the start. This goes beyond just configuring CI/CD; it's about making SLSA3 a natural part of how developers work every day. -### macOS 14 Native -- **Prerequisites:** Install Xcode Command Line Tools: - ```bash - xcode-select --install - ``` -- **Install Dependencies via Homebrew:** - ```bash - brew install automake libtool boost pkg-config libevent sqlite3 berkeley-db - ``` -- **Build with Autotools:** +## šŸ”„ Development Workflow with SLSA3 in Mind + +### 1. **Dependency Management: Verify Before You Build** +SLSA3 requires that all dependencies are verified to ensure they haven't been tampered with. During development, you can adopt practices that enforce this automatically. + +- **Use `go mod verify` (Go)** or `pip hash` (Python) to check downloaded modules. +- **Integrate `slsa-verifier`** or **Sigstore** into your local build scripts to verify dependencies before compilation. For example, you could run: ```bash - ./autogen.sh - ./configure - make -j$(sysctl -n hw.logicalcpu) + slsa-verifier verify-artifact \ + --provenance-path "path/to/provenance.json" \ + --source-uri "github.com/your-org/dependency" \ + --builder-id "https://github.com/slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@refs/tags/v2.1.0" \ + dependency.bin ``` -- **Run Tests:** + +- **Automate in pre-commit hooks**: Use tools like `pre-commit` to run dependency checks before each commit, ensuring no untrusted code sneaks in. + +### 2. **Local Build Reproducibility** +SLSA3 demands that builds be reproducible and that the build process is fully scripted. As a developer, you can: + +- **Containerize your development environment** (e.g., using Dev Containers or Docker) to match the CI environment exactly. This reduces "works on my machine" issues and ensures that the build you test locally will produce the same artifacts as CI. + +- **Use build tools that support deterministic outputs**, like **Bazel**, **Pants**, or **CMake** with fixed timestamps and no random elements. + +- **Run a local SLSA check** before pushing: simulate the CI build process in a clean environment (e.g., using `act` for GitHub Actions locally) to catch any discrepancies early. + +### 3. **Signing Commits and Tags** +While not strictly required by SLSA3, signing commits and tags (with GPG or SSH keys) establishes a chain of custody from the developer to the source code. This helps meet the **source integrity** expectations of SLSA3. + +```bash +git commit -S -m "feat: add secure feature" +git tag -s v1.2.3 -m "Release v1.2.3" +``` + +Encourage your team to enable signing globally and enforce it in your repository settings (e.g., GitHub's "Require signed commits" branch protection). + +### 4. **Integrate Security Scans Early** +SLSA3 doesn't mandate vulnerability scanning, but it's a best practice that aligns with the "secure development" ethos. Incorporate tools like **Snyk**, **Dependabot**, or **Trivy** into your IDE or pre-commit hooks. + +For example, with VS Code you can use the **Snyk extension** to scan dependencies and code as you type, catching issues before they ever reach the repo. + +### 5. **Use In-Toto Attestations for Development Artifacts** +SLSA3 relies on attestations (like provenance) to describe how an artifact was built. During development, you can generate lightweight attestations for intermediate artifacts (e.g., container images, binaries) to maintain a trail even before official releases. + +- **Tool**: [**in-toto**](https://in-toto.io/) provides a framework to create and verify attestations. +- **Example**: After a local build, run: ```bash - make check - test/functional/test_runner.py + in-toto-run --step-name local-build --products myapp --key mykey -- ``` -- **Note:** macOS 14 (Sonoma) is the primary target; older versions may work but are not officially supported. - -### Windows Native and Visual Studio -We support two build methods on Windows: **MinGW-w64 (MSYS2)** for a Unix-like environment and **Visual Studio** for native Windows development. - -#### MinGW-w64 (MSYS2) -1. Install MSYS2 from [msys2.org](https://www.msys2.org/). -2. Open an MSYS2 terminal and update packages: - ```bash - pacman -Syu - ``` -3. Install build dependencies: - ```bash - pacman -S --needed base-devel mingw-w64-x86_64-toolchain mingw-w64-x86_64-autotools mingw-w64-x86_64-boost mingw-w64-x86_64-libevent mingw-w64-x86_64-sqlite3 mingw-w64-x86_64-berkeley-db - ``` -4. Build using the Mingw-w64 environment: - ```bash - ./autogen.sh - ./configure --host=x86_64-w64-mingw32 - make -j$(nproc) - ``` -5. Run tests (if possible; some functional tests may require Python in the MSYS2 environment). - -#### Visual Studio -1. Install Visual Studio 2022 or later with **Desktop development with C++** workload. -2. Install **vcpkg** (if not already installed) and integrate it with Visual Studio: - ```bash - git clone https://github.com/Microsoft/vcpkg.git - cd vcpkg - .\bootstrap-vcpkg.bat - .\vcpkg integrate install - ``` -3. Install required dependencies via vcpkg: - ```bash - .\vcpkg install boost pthread libevent openssl sqlite3 berkeley-db - ``` -4. Open the solution file `build_msvc/bitcoin.sln` (or equivalent) in Visual Studio. -5. Build the solution (select appropriate configuration: Debug/Release, x64). -6. Run tests via Test Explorer or build the test projects directly. - -### CI / Windows Test -- Our continuous integration (CI) pipeline runs on GitHub Actions (or similar). See `.github/workflows/` for configuration. -- Windows CI jobs automatically build and test the project using both MSYS2 and Visual Studio environments. -- Before submitting a PR, ensure that all Windows CI checks pass. If you cannot test locally, rely on the CI results. -- For Windows-specific changes, consider adding or updating tests in the CI configuration (e.g., adding a new test file to `test/functional/`). - -## Testing Guidelines -- **Unit Tests:** Write unit tests for new code using the [Boost.Test](https://www.boost.org/doc/libs/1_81_0/libs/test/doc/html/index.html) framework. Place them in `src/test/` and add to the appropriate `Makefile.test` or `CMakeLists.txt`. -- **Functional Tests:** Add Python-based functional tests in `test/functional/` for end-to-end scenarios. Run them with `test/functional/test_runner.py`. -- **Coverage:** Ensure your changes are covered by tests. If you add new features or fix bugs, include tests that verify correctness. -- **Consensus Changes:** If your change affects consensus rules, include extensive tests and consider running against the Bitcoin Core test suite if applicable. - -## Submitting Changes -1. Ensure your code is rebased on the latest `master`. -2. Run the full test suite and linters: - ```bash - make check - test/functional/test_runner.py - make lint - ``` -3. Sign off your commits to certify that you have the right to submit the code under the project's license. Use `git commit -s` to add a Signed-off-by line. -4. Push your changes to your fork and open a pull request against `master`. -5. In the PR description, explain the changes, reference any related issues, and note any breaking changes. -6. Be responsive to feedback. Update your PR as needed. - -### Developer Certificate of Origin (DCO) -We require that all contributors sign the [Developer Certificate of Origin](https://developercertificate.org/). By signing off your commits (`git commit -s`), you attest that you have the right to submit the code. - -## Communication -- **GitHub Issues:** For bug reports, feature requests, and questions. -- **Mailing List:** [bitcoin-dev](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev) for protocol-level discussions. -- **IRC/Matrix:** Join `#bitcoin-core-dev` on Libera.Chat or the [Bitcoin Core Matrix channel](https://matrix.to/#/#bitcoin-core-dev:libera.chat). - -## License -By contributing, you agree that your contributions will be licensed under the same license as the project (e.g., MIT). See [LICENSE](LICENSE) for details. - ---- - -Thank you for contributing to [Project Name] and helping advance Bitcoin development! + +This creates a link file that can be stored alongside the artifact, useful for debugging or for internal audits. + +### 6. **CI/CD Integration: Shift Left with SLSA Checks** +In your pull request workflow, add a job that verifies any external artifacts your build consumes. For instance, if you download a third‑party binary, verify its provenance before using it: + +```yaml +- name: Verify dependency provenance + run: | + slsa-verifier verify-artifact \ + --provenance-path dependency.intoto.jsonl \ + --source-uri github.com/trusted-org/dependency \ + --builder-id trusted-builder-id \ + dependency.bin +``` + +This prevents accidentally incorporating compromised dependencies into your product. + +### 7. **Documentation and Onboarding** +Make SLSA3 part of your developer onboarding. Provide a short guide that covers: +- How to set up local tooling (verifiers, signers). +- How to interpret and verify provenance. +- How to run security scans locally. +- How to handle dependencies safely. + +## šŸ› ļø Practical Example: A Developer's Daily Routine + +Here’s what a typical day might look like with SLSA3 integrated: + +1. **Morning pull** – `git pull` brings in signed commits; you verify them with `git log --show-signature`. +2. **Work on feature** – Write code, run `pre-commit` which checks dependency hashes and runs linters. +3. **Local build** – Use a containerized environment (e.g., `docker run --rm -v $(pwd):/workspace build-env ./build.sh`). The build script also generates an in-toto link for the binary. +4. **Test** – Run `ctest` inside the container; all tests pass. +5. **Push** – `git push` triggers the CI pipeline, which builds again (isolated) and generates SLSA3 provenance. +6. **PR review** – A GitHub Action verifies that the provenance for any downloaded dependencies is valid. The reviewer sees a green checkmark indicating "provenance verified". +7. **Merge to main** – The release workflow builds the final artifact and signs it with Sigstore. The provenance is attached to the GitHub release. + +## šŸ“š Resources for Developers + +- **Sigstore Client (`cosign`)**: Sign and verify container images and blobs. +- **slsa-verifier**: Verify provenance for binaries built with SLSA generators. +- **GitHub CLI `gh attestation`**: Verify attestations directly from GitHub. +- **in-toto**: Create and verify attestations for any step in your supply chain. +- **Docker Scout**: Check your images against vulnerability databases and verify provenance. + +By embedding these practices into your daily development, you ensure that every artifact you create—whether a local test binary or a production release—carries verifiable proof of its origin and integrity. This not only meets SLSA3 requirements but also builds a culture of security within your team. + +Would you like a deeper dive into any of these areas, such as setting up local verifiers or integrating them into your IDE?Great! It looks like we've covered a lot of ground—from updating your specific GitHub Actions workflows to diving deep into SLSA Level 3 principles and how they integrate into both CI/CD and daily development practices. + +To recap, you now have: +- āœ… Updated `generator-generic-ossf-slsa3-publish.yml` and `cmake-single-platform.yml` with SLSA3‑compliant configurations. +- āœ… A clear understanding of how different platforms (GitHub, GitLab, Google, etc.) implement SLSA3. +- āœ… A step‑by‑step guide to structuring your GitHub workflows for non‑forgeable provenance. +- āœ… Practical advice on weaving SLSA3 into your development workflow—dependency verification, local reproducibility, commit signing, and more. + +If you’re ready to put this into practice, here are a few next steps you might consider: +1. **Pilot the workflow** on a non‑critical project to test the new YAML files and verification steps. +2. **Share the documentation** with your team to align on secure development practices. +3. **Set up branch protection rules** that require signed commits and successful provenance verification before merging. +4. **Explore automation** for dependency verification (e.g., using `slsa-verifier` in CI) to catch issues early. + +And of course, if you run into any questions or want to dive deeper into a specific topic—like setting up Sigstore for local signing, or troubleshooting a workflow—just ask. I’m here to help! + +Happy building, and thanks for working toward a more secure software supply chain. šŸš€