Compare commits
8 Commits
c306e1db1a
..
1.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
 t.behrendt
|
4e1d3c0090 | ||
 renovate-bot
|
cc54a9d3c6 | ||
|
renovate-bot
|
2aecdb373d | ||
|
renovate-bot
|
e9b699a881 | ||
|
renovate-bot
|
84e1bf7e51 | ||
|
t.behrendt
|
0199d06001 | ||
|
t.behrendt
|
2866c3983b | ||
|
t.behrendt
|
bb6706d1a0 |
@@ -1,41 +0,0 @@
|
||||
name: "CI Summary"
|
||||
description: "Writes CI validation summary to GITHUB_STEP_SUMMARY"
|
||||
inputs:
|
||||
has_k8s:
|
||||
description: "Whether Kubernetes manifests were detected"
|
||||
required: true
|
||||
has_helmfile:
|
||||
description: "Whether helmfile.yaml was detected"
|
||||
required: true
|
||||
skip_helm_validation:
|
||||
description: "Whether Helm validation is manually disabled"
|
||||
required: true
|
||||
runs:
|
||||
using: "composite"
|
||||
steps:
|
||||
- shell: bash
|
||||
run: |
|
||||
echo "## CI Validation Summary" >> "$GITHUB_STEP_SUMMARY"
|
||||
echo "" >> "$GITHUB_STEP_SUMMARY"
|
||||
|
||||
if [ "${{ inputs.has_k8s }}" = "true" ]; then
|
||||
echo "✅ **Kubernetes validation**: Completed" >> "$GITHUB_STEP_SUMMARY"
|
||||
else
|
||||
echo "❌ **Kubernetes validation**: Skipped (no k8s/ directory found)" >> "$GITHUB_STEP_SUMMARY"
|
||||
fi
|
||||
|
||||
if [ "${{ inputs.has_helmfile }}" = "true" ] && [ "${{ inputs.skip_helm_validation }}" != "true" ]; then
|
||||
echo "✅ **Helm validation**: Completed" >> "$GITHUB_STEP_SUMMARY"
|
||||
elif [ "${{ inputs.has_helmfile }}" = "true" ] && [ "${{ inputs.skip_helm_validation }}" = "true" ]; then
|
||||
echo "⏭️ **Helm validation**: Skipped (manually disabled)" >> "$GITHUB_STEP_SUMMARY"
|
||||
else
|
||||
echo "⏭️ **Helm validation**: Skipped (no helmfile.yaml found)" >> "$GITHUB_STEP_SUMMARY"
|
||||
fi
|
||||
|
||||
echo "" >> "$GITHUB_STEP_SUMMARY"
|
||||
if [ "${{ inputs.has_helmfile }}" = "true" ]; then
|
||||
service_type="Helm + Kubernetes"
|
||||
else
|
||||
service_type="Kubernetes Only"
|
||||
fi
|
||||
echo "**Service Type**: ${service_type}" >> "$GITHUB_STEP_SUMMARY"
|
||||
@@ -1,41 +0,0 @@
|
||||
name: "Deployment Summary"
|
||||
description: "Writes deployment summary to GITHUB_STEP_SUMMARY"
|
||||
inputs:
|
||||
has_k8s:
|
||||
description: "Whether Kubernetes manifests were detected"
|
||||
required: true
|
||||
has_helmfile:
|
||||
description: "Whether helmfile.yaml was detected"
|
||||
required: true
|
||||
skip_helm_deployment:
|
||||
description: "Whether Helm deployment is manually disabled"
|
||||
required: true
|
||||
runs:
|
||||
using: "composite"
|
||||
steps:
|
||||
- shell: bash
|
||||
run: |
|
||||
echo "## Deployment Summary" >> "$GITHUB_STEP_SUMMARY"
|
||||
echo "" >> "$GITHUB_STEP_SUMMARY"
|
||||
|
||||
if [ "${{ inputs.has_k8s }}" = "true" ]; then
|
||||
echo "✅ **Kubernetes deployment**: Completed" >> "$GITHUB_STEP_SUMMARY"
|
||||
else
|
||||
echo "❌ **Kubernetes deployment**: Skipped (no k8s/ directory found)" >> "$GITHUB_STEP_SUMMARY"
|
||||
fi
|
||||
|
||||
if [ "${{ inputs.has_helmfile }}" = "true" ] && [ "${{ inputs.skip_helm_deployment }}" != "true" ]; then
|
||||
echo "✅ **Helm deployment**: Completed" >> "$GITHUB_STEP_SUMMARY"
|
||||
elif [ "${{ inputs.has_helmfile }}" = "true" ] && [ "${{ inputs.skip_helm_deployment }}" = "true" ]; then
|
||||
echo "⏭️ **Helm deployment**: Skipped (manually disabled)" >> "$GITHUB_STEP_SUMMARY"
|
||||
else
|
||||
echo "⏭️ **Helm deployment**: Skipped (no helmfile.yaml found)" >> "$GITHUB_STEP_SUMMARY"
|
||||
fi
|
||||
|
||||
echo "" >> "$GITHUB_STEP_SUMMARY"
|
||||
if [ "${{ inputs.has_helmfile }}" = "true" ]; then
|
||||
service_type="Helm + Kubernetes"
|
||||
else
|
||||
service_type="Kubernetes Only"
|
||||
fi
|
||||
echo "**Service Type**: ${service_type}" >> "$GITHUB_STEP_SUMMARY"
|
||||
@@ -28,19 +28,11 @@ on:
|
||||
required: false
|
||||
default: "{}"
|
||||
type: string
|
||||
outputs:
|
||||
has_k8s:
|
||||
description: "Whether Kubernetes manifests were detected"
|
||||
value: ${{ jobs.summary-data.outputs.has_k8s }}
|
||||
has_helmfile:
|
||||
description: "Whether helmfile.yaml was detected"
|
||||
value: ${{ jobs.summary-data.outputs.has_helmfile }}
|
||||
skip_helm_deployment:
|
||||
description: "Whether Helm deployment was manually skipped"
|
||||
value: ${{ jobs.summary-data.outputs.skip_helm_deployment }}
|
||||
service_type:
|
||||
description: "Service type inferred from repository contents"
|
||||
value: ${{ jobs.summary-data.outputs.service_type }}
|
||||
namespace:
|
||||
description: "Override the default namespace (extracted from repository name)"
|
||||
required: false
|
||||
default: ""
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
detect-service-type:
|
||||
@@ -77,10 +69,19 @@ jobs:
|
||||
if: inputs.skip_shared_secrets_deployment != 'true'
|
||||
steps:
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
- name: Set restic backup secret
|
||||
uses: azure/k8s-create-secret@6e0ba8047235646753f2a3a3b359b4d0006ff218 # v5.0.1
|
||||
- uses: https://gitea.t000-n.de/t.behrendt/k_deploy_actions/.gitea/actions/extract-namespace-from-repo-name@0.0.1
|
||||
id: namespace
|
||||
with:
|
||||
namespace: ${{ steps.namespace.outputs.namespace }}
|
||||
repo: ${{ github.repository }}
|
||||
- uses: azure/setup-kubectl@829323503d1be3d00ca8346e5391ca0b07a9ab0d # v5.1.0
|
||||
- uses: azure/k8s-set-context@89b837d75b40a7bd2ddafde837473c212db8b313 # v5.0.0
|
||||
with:
|
||||
method: kubeconfig
|
||||
kubeconfig: ${{ secrets.KUBECONFIG }}
|
||||
- name: Set restic backup secret
|
||||
uses: azure/k8s-create-secret@5e49ad902ac755e0815974a44904c728da961747 # v6.0.0
|
||||
with:
|
||||
namespace: ${{ inputs.namespace || steps.namespace.outputs.namespace }}
|
||||
secret-name: backupsidecar-secret
|
||||
secret-type: generic
|
||||
data: |
|
||||
@@ -112,7 +113,7 @@ jobs:
|
||||
action: deploy
|
||||
manifests: "${{ inputs.k8s_dir }}"
|
||||
strategy: basic
|
||||
namespace: ${{ steps.namespace.outputs.namespace }}
|
||||
namespace: ${{ inputs.namespace || steps.namespace.outputs.namespace }}
|
||||
|
||||
deploy-helm:
|
||||
runs-on: ubuntu-latest
|
||||
@@ -134,35 +135,36 @@ jobs:
|
||||
method: kubeconfig
|
||||
kubeconfig: ${{ secrets.KUBECONFIG }}
|
||||
- name: Deploy Helm
|
||||
uses: helmfile/helmfile-action@02671705b1dda1dc4b0a4ddd4f9f1ea8f4568c6f # v2.4.3
|
||||
uses: helmfile/helmfile-action@f6f7844b9e6d9f5ac8cf4cdae8ada1a42755c036 # v2.4.4
|
||||
with:
|
||||
helmfile-args: apply
|
||||
namespace: ${{ inputs.namespace || steps.namespace.outputs.namespace }}
|
||||
env: ${{ fromJSON(inputs.helmfile_env) }}
|
||||
|
||||
summary-data:
|
||||
# Summary job that always runs to show what was deployed
|
||||
deployment-summary:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [detect-service-type, deploy-k8s, deploy-helm]
|
||||
if: always()
|
||||
outputs:
|
||||
has_k8s: ${{ steps.export.outputs.has_k8s }}
|
||||
has_helmfile: ${{ steps.export.outputs.has_helmfile }}
|
||||
skip_helm_deployment: ${{ steps.export.outputs.skip_helm_deployment }}
|
||||
service_type: ${{ steps.export.outputs.service_type }}
|
||||
steps:
|
||||
- name: Export summary data
|
||||
id: export
|
||||
- name: Deployment Summary
|
||||
run: |
|
||||
has_k8s="${{ needs.detect-service-type.outputs.has_k8s }}"
|
||||
has_helmfile="${{ needs.detect-service-type.outputs.has_helmfile }}"
|
||||
skip_helm_deployment="${{ inputs.skip_helm_deployment }}"
|
||||
echo "## Deployment Summary" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
if [ "$has_helmfile" = "true" ]; then
|
||||
service_type="Helm + Kubernetes"
|
||||
if [ "${{ needs.detect-service-type.outputs.has_k8s }}" == "true" ]; then
|
||||
echo "✅ **Kubernetes deployment**: Completed" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
service_type="Kubernetes Only"
|
||||
echo "❌ **Kubernetes deployment**: Skipped (no k8s/ directory found)" >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
|
||||
echo "has_k8s=$has_k8s" >> "$GITHUB_OUTPUT"
|
||||
echo "has_helmfile=$has_helmfile" >> "$GITHUB_OUTPUT"
|
||||
echo "skip_helm_deployment=$skip_helm_deployment" >> "$GITHUB_OUTPUT"
|
||||
echo "service_type=$service_type" >> "$GITHUB_OUTPUT"
|
||||
if [ "${{ needs.detect-service-type.outputs.has_helmfile }}" == "true" ] && [ "${{ inputs.skip_helm_deployment }}" != "true" ]; then
|
||||
echo "✅ **Helm deployment**: Completed" >> $GITHUB_STEP_SUMMARY
|
||||
elif [ "${{ needs.detect-service-type.outputs.has_helmfile }}" == "true" ] && [ "${{ inputs.skip_helm_deployment }}" == "true" ]; then
|
||||
echo "⏭️ **Helm deployment**: Skipped (manually disabled)" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
echo "⏭️ **Helm deployment**: Skipped (no helmfile.yaml found)" >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**Service Type**: ${{ needs.detect-service-type.outputs.has_helmfile == 'true' && 'Helm + Kubernetes' || 'Kubernetes Only' }}" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
@@ -5,8 +5,9 @@ on:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- ".gitea/workflows/cd.yaml"
|
||||
- ".gitea/workflows/ci.yaml"
|
||||
- ".gitea/workflows/deploy.yaml"
|
||||
- ".gitea/workflows/validate.yaml"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
release:
|
||||
@@ -22,6 +23,6 @@ jobs:
|
||||
with:
|
||||
token: ${{ secrets.GITEA_TOKEN }}
|
||||
- name: Push tag
|
||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@47a1c635cfc76cfb4eeee3db0d0b89bf19007c7a # 0.2.3
|
||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@38c1bbd8bad3e7965744d03de85faa4a5b808d1b # 0.2.4
|
||||
with:
|
||||
tag: ${{ steps.tag.outputs.new-tag }}
|
||||
|
||||
@@ -23,19 +23,11 @@ on:
|
||||
required: false
|
||||
default: "{}"
|
||||
type: string
|
||||
outputs:
|
||||
has_k8s:
|
||||
description: "Whether Kubernetes manifests were detected"
|
||||
value: ${{ jobs.summary-data.outputs.has_k8s }}
|
||||
has_helmfile:
|
||||
description: "Whether helmfile.yaml was detected"
|
||||
value: ${{ jobs.summary-data.outputs.has_helmfile }}
|
||||
skip_helm_validation:
|
||||
description: "Whether Helm validation was manually skipped"
|
||||
value: ${{ jobs.summary-data.outputs.skip_helm_validation }}
|
||||
service_type:
|
||||
description: "Service type inferred from repository contents"
|
||||
value: ${{ jobs.summary-data.outputs.service_type }}
|
||||
namespace:
|
||||
description: "Override the default namespace (extracted from repository name)"
|
||||
required: false
|
||||
default: ""
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
detect-service-type:
|
||||
@@ -82,9 +74,9 @@ jobs:
|
||||
method: kubeconfig
|
||||
kubeconfig: ${{ secrets.KUBECONFIG }}
|
||||
- name: Validate k8s manifests
|
||||
uses: azure/k8s-lint@6aefe5066f95e73d2b140d8835cc95583b886989 # v3.0.1
|
||||
uses: azure/k8s-lint@e4234c50ea835112e72b145bdecd00a94bad42fd # v4.0.0
|
||||
with:
|
||||
namespace: ${{ steps.namespace.outputs.namespace }}
|
||||
namespace: ${{ inputs.namespace || steps.namespace.outputs.namespace }}
|
||||
lintType: dryrun
|
||||
manifests: "${{ inputs.k8s_dir }}"
|
||||
|
||||
@@ -108,35 +100,36 @@ jobs:
|
||||
method: kubeconfig
|
||||
kubeconfig: ${{ secrets.KUBECONFIG }}
|
||||
- name: Validate Helm
|
||||
uses: helmfile/helmfile-action@02671705b1dda1dc4b0a4ddd4f9f1ea8f4568c6f # v2.4.3
|
||||
uses: helmfile/helmfile-action@f6f7844b9e6d9f5ac8cf4cdae8ada1a42755c036 # v2.4.4
|
||||
with:
|
||||
helmfile-args: diff
|
||||
namespace: ${{ inputs.namespace || steps.namespace.outputs.namespace }}
|
||||
env: ${{ fromJSON(inputs.helmfile_env) }}
|
||||
|
||||
summary-data:
|
||||
# Summary job that always runs to show what was validated
|
||||
ci-summary:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [detect-service-type, validate-k8s, validate-helm]
|
||||
if: always()
|
||||
outputs:
|
||||
has_k8s: ${{ steps.export.outputs.has_k8s }}
|
||||
has_helmfile: ${{ steps.export.outputs.has_helmfile }}
|
||||
skip_helm_validation: ${{ steps.export.outputs.skip_helm_validation }}
|
||||
service_type: ${{ steps.export.outputs.service_type }}
|
||||
steps:
|
||||
- name: Export summary data
|
||||
id: export
|
||||
- name: CI Summary
|
||||
run: |
|
||||
has_k8s="${{ needs.detect-service-type.outputs.has_k8s }}"
|
||||
has_helmfile="${{ needs.detect-service-type.outputs.has_helmfile }}"
|
||||
skip_helm_validation="${{ inputs.skip_helm_validation }}"
|
||||
echo "## CI Validation Summary" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
if [ "$has_helmfile" = "true" ]; then
|
||||
service_type="Helm + Kubernetes"
|
||||
if [ "${{ needs.detect-service-type.outputs.has_k8s }}" == "true" ]; then
|
||||
echo "✅ **Kubernetes validation**: Completed" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
service_type="Kubernetes Only"
|
||||
echo "❌ **Kubernetes validation**: Skipped (no k8s/ directory found)" >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
|
||||
echo "has_k8s=$has_k8s" >> "$GITHUB_OUTPUT"
|
||||
echo "has_helmfile=$has_helmfile" >> "$GITHUB_OUTPUT"
|
||||
echo "skip_helm_validation=$skip_helm_validation" >> "$GITHUB_OUTPUT"
|
||||
echo "service_type=$service_type" >> "$GITHUB_OUTPUT"
|
||||
if [ "${{ needs.detect-service-type.outputs.has_helmfile }}" == "true" ] && [ "${{ inputs.skip_helm_validation }}" != "true" ]; then
|
||||
echo "✅ **Helm validation**: Completed" >> $GITHUB_STEP_SUMMARY
|
||||
elif [ "${{ needs.detect-service-type.outputs.has_helmfile }}" == "true" ] && [ "${{ inputs.skip_helm_validation }}" == "true" ]; then
|
||||
echo "⏭️ **Helm validation**: Skipped (manually disabled)" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
echo "⏭️ **Helm validation**: Skipped (no helmfile.yaml found)" >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**Service Type**: ${{ needs.detect-service-type.outputs.has_helmfile == 'true' && 'Helm + Kubernetes' || 'Kubernetes Only' }}" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
@@ -1,79 +1,77 @@
|
||||
> [!WARNING]
|
||||
> Repo is currently not in use and not tested.
|
||||
> We are waiting for proper shared workflow UI support in gitea. Otherwise errors are hard to identify.
|
||||
> Follow https://github.com/go-gitea/gitea/issues/24604
|
||||
# Reusable CI/CD Workflows for k\_ Services
|
||||
|
||||
# Reusable CI Workflow for Kubernetes Services
|
||||
|
||||
This directory contains a reusable CI workflow that automatically detects and validates your Kubernetes services, whether they use Helm + Kubernetes or just Kubernetes manifests.
|
||||
This repository contains reusable CI and CD workflows that automatically detect Kubernetes service type (Kubernetes-only vs Helm + Kubernetes) and execute the relevant steps.
|
||||
|
||||
## Features
|
||||
|
||||
- **Automatic Detection**: Automatically detects if your service uses Helm (helmfile.yaml) or just Kubernetes manifests
|
||||
- **Conditional Validation**: Only runs Helm validation when helmfile.yaml exists
|
||||
- **Flexible Paths**: Configurable paths for k8s directory and helmfile
|
||||
- **Comprehensive Validation**: Validates both Kubernetes manifests and Helm charts
|
||||
- **CI Summary**: Provides a clear summary of what was validated
|
||||
- **Reusable CI and CD**: Separate reusable workflows for validation and deployment
|
||||
- **Automatic Detection**: Detects whether `helmfile.yaml` exists and whether `k8s/` exists
|
||||
- **Conditional Execution**: Runs Helm steps only when applicable
|
||||
- **Flexible Inputs**: Supports custom `k8s_dir` and `helmfile_path`
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Usage (Recommended)
|
||||
### Basic CI Usage
|
||||
|
||||
Simply call the workflow without any parameters - it will automatically detect your service type:
|
||||
Call the reusable CI workflow:
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
ci:
|
||||
uses: ./.gitea/workflows/ci.yaml
|
||||
uses: https://gitea.t000-n.de/t.behrendt/k_deploy_workflows/.gitea/workflows/ci.yaml@main
|
||||
secrets: inherit
|
||||
```
|
||||
|
||||
### Advanced Usage with Custom Paths
|
||||
### Basic CD Usage
|
||||
|
||||
If your service uses non-standard directory names:
|
||||
Call the reusable CD workflow:
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
deploy:
|
||||
uses: https://gitea.t000-n.de/t.behrendt/k_deploy_workflows/.gitea/workflows/cd.yaml@main
|
||||
secrets: inherit
|
||||
```
|
||||
|
||||
### Advanced Usage with Custom Paths and Flags
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
ci:
|
||||
uses: ./.gitea/workflows/ci.yaml
|
||||
uses: https://gitea.t000-n.de/t.behrendt/k_deploy_workflows/.gitea/workflows/ci.yaml@main
|
||||
with:
|
||||
k8s_dir: "kubernetes/"
|
||||
helmfile_path: "helm/helmfile.yaml"
|
||||
```
|
||||
|
||||
### Force Skip Helm Validation
|
||||
|
||||
If you want to skip Helm validation even when helmfile.yaml exists:
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
ci:
|
||||
uses: ./.gitea/workflows/ci.yaml
|
||||
with:
|
||||
skip_helm_validation: true
|
||||
secrets: inherit
|
||||
```
|
||||
|
||||
## Input Parameters
|
||||
## Inputs
|
||||
|
||||
### CI (`.gitea/workflows/ci.yaml`)
|
||||
|
||||
| Parameter | Description | Default | Required |
|
||||
| ---------------------- | -------------------------------------------- | --------------- | -------- |
|
||||
| ---------------------- | --------------------------------------------------------------- | --------------- | -------- |
|
||||
| `k8s_dir` | Path to Kubernetes manifests directory | `k8s/` | No |
|
||||
| `helmfile_path` | Path to helmfile.yaml | `helmfile.yaml` | No |
|
||||
| `skip_helm_validation` | Skip Helm validation even if helmfile exists | `false` | No |
|
||||
| `helmfile_env` | JSON object string passed as env to helmfile | `{}` | No |
|
||||
| `namespace` | Override the default namespace (extracted from repository name) | `""` | No |
|
||||
|
||||
### CD (`.gitea/workflows/cd.yaml`)
|
||||
|
||||
| Parameter | Description | Default | Required |
|
||||
| -------------------------------- | --------------------------------------------------------------- | --------------- | -------- |
|
||||
| `k8s_dir` | Path to Kubernetes manifests directory | `k8s/` | No |
|
||||
| `helmfile_path` | Path to helmfile.yaml | `helmfile.yaml` | No |
|
||||
| `skip_helm_deployment` | Skip Helm deployment even if helmfile exists | `false` | No |
|
||||
| `skip_shared_secrets_deployment` | Skip shared secrets deployment | `false` | No |
|
||||
| `helmfile_env` | JSON object string passed as env to helmfile | `{}` | No |
|
||||
| `namespace` | Override the default namespace (extracted from repository name) | `""` | No |
|
||||
|
||||
## Directory Structure Requirements
|
||||
|
||||
### For Kubernetes-only services:
|
||||
|
||||
```
|
||||
your-service/
|
||||
├── k8s/
|
||||
│ ├── deployment.yaml
|
||||
│ ├── service.yaml
|
||||
│ └── ...
|
||||
└── .gitea/workflows/your-workflow.yaml
|
||||
```
|
||||
|
||||
### For Helm + Kubernetes services:
|
||||
### Full example structure (Helm + Kubernetes):
|
||||
|
||||
```
|
||||
your-service/
|
||||
@@ -84,79 +82,3 @@ your-service/
|
||||
├── helmfile.yaml
|
||||
└── .gitea/workflows/your-workflow.yaml
|
||||
```
|
||||
|
||||
## What Gets Validated
|
||||
|
||||
### Always (if k8s/ directory exists):
|
||||
|
||||
- Kubernetes manifest validation using `kubectl --dry-run`
|
||||
- Namespace extraction from repository name
|
||||
- Basic Kubernetes syntax and schema validation
|
||||
|
||||
### Conditionally (if helmfile.yaml exists and Helm validation not skipped):
|
||||
|
||||
- Helm chart validation using `helmfile diff`
|
||||
- Kubernetes manifests in Helm context
|
||||
- Helm-specific configurations and values
|
||||
|
||||
## Example Workflows
|
||||
|
||||
See `example-usage.yaml` for complete examples of how to use this workflow in different scenarios.
|
||||
|
||||
## Available Actions
|
||||
|
||||
### Extract Chart Name from Repository Name
|
||||
|
||||
The `extract-chart-name-from-repo-name` action extracts the chart name from repository names following the `helm-<chart-name>` convention.
|
||||
|
||||
#### Usage
|
||||
|
||||
```yaml
|
||||
- name: Extract chart name
|
||||
uses: ./.gitea/actions/extract-chart-name-from-repo-name
|
||||
with:
|
||||
repo: ${{ github.repository_name }} # e.g., "helm-my-service"
|
||||
```
|
||||
|
||||
#### Inputs
|
||||
|
||||
| Parameter | Description | Required |
|
||||
| --------- | ------------------------------------------------ | -------- |
|
||||
| `repo` | The full repository name (e.g., "helm-my-chart") | Yes |
|
||||
|
||||
#### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ------------ | ---------------------------------------------------------------- |
|
||||
| `chart-name` | The extracted chart name (e.g., "my-chart" from "helm-my-chart") |
|
||||
|
||||
#### Example
|
||||
|
||||
For a repository named `helm-user-service`, this action will extract `user-service` as the chart name.
|
||||
|
||||
## Dependencies
|
||||
|
||||
This workflow requires:
|
||||
|
||||
- `./.gitea/actions/extract-namespace-from-repo-name` action
|
||||
- `./.gitea/actions/extract-chart-name-from-repo-name` action
|
||||
- `KUBECONFIG` secret configured in your repository
|
||||
- Access to your Kubernetes cluster
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Helm validation skipped unexpectedly
|
||||
|
||||
- Check if `helmfile.yaml` exists in the expected location
|
||||
- Verify the `skip_helm_validation` parameter is not set to `true`
|
||||
- Ensure the file path is correct if using custom paths
|
||||
|
||||
### Kubernetes validation skipped
|
||||
|
||||
- Verify the `k8s/` directory (or custom path) exists
|
||||
- Check the directory contains valid Kubernetes manifests
|
||||
|
||||
### Permission issues
|
||||
|
||||
- Ensure the `KUBECONFIG` secret is properly configured
|
||||
- Verify the workflow has access to your Kubernetes cluster
|
||||
|
||||
Reference in New Issue
Block a user