blueprint-workflows

About this project

Workflows and Actions for Blueprints & Building Blocks for Open Managed Control Planes.

This project provides reusable GitHub Workflows and Actions designed for projects following the structure of blueprints and blueprint-building-blocks. These workflows and actions streamline CI/CD processes for Helm Charts allowing for more detailed Kubernetes manifests reviews of the changes before deployment using GitOps tools like Flux.

Requirements and Setup

Prerequisites

1. GitHub Repository Structure: Ensure your repository follows the structure of the referenced blueprints and building blocks.
2. GitHub Actions permissions: Ensure that you have access to the reusable workflows from your repository: Access to reusable workflows
3. GitHub Tokens: If necessary set up a GitHub tokens with appropriate permissions for repostories and Helm registries.

Workflows

1. Continuous Integration (ci.yml)

• Description: Continously install dependencies, build packages, and run tests.
• Usage:

  jobs:
    test-action:
      uses: openmcp-project/blueprint-workflows/.github/workflows/ci.yml@main

2. PR Status Checks (git-pr-status-checks.yml)

• Description: Performs Helm Chart listing, dependency updates, linting, manifest validation, and version bumping for pull requests.
• Usage:

  jobs:
    pr-status-check:
      uses: openmcp-project/blueprint-workflows/.github/workflows/git-pr-status-checks.yml@main

3. Lint Codebase (linter.yml)

• Description: Lints the codebase for JavaScript, TypeScript, and other supported languages.
• Usage:

  jobs:
    lint:
      uses: openmcp-project/blueprint-workflows/.github/workflows/linter.yml@main

4. Check Transpiled JavaScript (check-dist.yml)

• Description: Ensures the dist/ directory contains the expected transpiled code.
• Usage:

  jobs:
    check-dist:
      uses: openmcp-project/blueprint-workflows/.github/workflows/check-dist.yml@main

5. CodeQL Analysis (codeql-analysis.yml)

• Description: Performs CodeQL analysis for security and code quality.
• Usage:

  jobs:
    codeql-analysis:
      uses: openmcp-project/blueprint-workflows/.github/workflows/codeql-analysis.yml@main

Actions

1. Helm Chart Listing

• Description: Lists all Helm Charts in the repository.
• Usage:

  steps:
    - id: helm-chart-listing
      uses: openmcp-project/blueprint-workflows/.github/actions/helm-chart/listing@main

2. Helm Chart Dependency Build/Update

• Description: Updates dependencies for all Helm Charts.
• Usage:

  steps:
    - id: helm-chart-dep-build
      uses: openmcp-project/blueprint-workflows/.github/actions/helm-chart/dep-build@main

3. Helm Chart Linting

• Description: Lints all Helm Charts for errors and warnings.
• Usage:

  steps:
    - id: helm-chart-linting
      uses: openmcp-project/blueprint-workflows/.github/actions/helm-chart/linting@main

4. Helm Chart Manifest Validation

• Description: Validates Helm Chart manifests.
• Usage:

  steps:
    - id: helm-chart-manifest-validation
      uses: openmcp-project/blueprint-workflows/.github/actions/helm-chart/manifest-validation@main

5. Helm Chart Version Bump

• Description: Bumps the version of modified Helm Charts.
• Usage:

  steps:
    - id: helm-chart-version-bump
      uses: openmcp-project/blueprint-workflows/.github/actions/helm-chart/version-bump@main
      with:
        BRANCH_NAME: ${{ github.event.pull_request.head.ref }}
        BASE_BRANCH_NAME: main

6. Helm Chart Documentation

• Description: Generates README.md documentation for Helm Charts.
• Usage:

  steps:
    - id: helm-chart-docs
      uses: openmcp-project/blueprint-workflows/.github/actions/helm-chart/docs@main

7. K8s Manifest Templating

• Description: Templates and validates Kubernetes manifests for Helm Charts.
• Usage:

  steps:
    - id: k8s-manifest-templating
      uses: openmcp-project/blueprint-workflows/.github/actions/k8s-manifest-templating@main

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.

Security / Disclosure

If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.

Licensing

Copyright 2025 SAP SE or an SAP affiliate company and blueprint-workflows contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.