Files
headlamp-sealed-secrets-plugin/.github/workflows/publish.yml
T
Chris Farhood 78f5074818 chore: optimize Git workflow and CI/CD for Headlamp plugin releases
Implements comprehensive workflow redesign addressing:
- Non-deterministic builds → Fixed with consistent Node version and npm ci
- Manual checksum management → Automated in publish workflow
- Multiple artifact locations → Single source of truth (GitHub releases)
- Individual file releases → Single tarball artifact
- Artifact Hub mismatches → No rebuild risk, use released tarball

Key improvements:
- CI workflow: faster builds with npm cache, artifact verification
- Publish workflow: deterministic builds, automatic checksum calculation,
  auto-commit of metadata updates, single tarball release
- Branch protection: require PR review and passing CI before merge
- Release process: simplified from manual to 5-minute automated workflow

Documentation:
- GIT_WORKFLOW.md: branching strategy, commit conventions, release process
- RELEASE_GUIDE.md: detailed step-by-step release instructions
- RELEASE_QUICK_REFERENCE.md: copy-paste commands for quick releases
- CI_CD_DESIGN.md: technical architecture and design decisions
- GITHUB_SETUP_CHECKLIST.md: repository configuration guide
- WORKFLOW_OPTIMIZATION_SUMMARY.md: executive summary of changes

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-02-12 13:43:39 -05:00

167 lines
5.5 KiB
YAML

name: Publish Release
on:
push:
tags:
- 'v*'
workflow_dispatch:
jobs:
publish:
runs-on: local-ubuntu-latest
timeout-minutes: 15
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: headlamp-sealed-secrets/package-lock.json
- name: Extract version from tag
id: version
run: |
VERSION=${GITHUB_REF#refs/tags/v}
echo "version=${VERSION}" >> $GITHUB_OUTPUT
echo "Version: ${VERSION}"
- name: Install dependencies
working-directory: ./headlamp-sealed-secrets
run: npm ci
- name: Run type check
working-directory: ./headlamp-sealed-secrets
run: npm run tsc
- name: Run linter
working-directory: ./headlamp-sealed-secrets
run: npm run lint
- name: Build plugin (deterministic)
working-directory: ./headlamp-sealed-secrets
run: npm run build
env:
NODE_ENV: production
- name: Create tarball (deterministic packaging)
id: tarball
working-directory: ./headlamp-sealed-secrets
run: |
# Use npm pack to create deterministic tarball
TARBALL=$(npm pack --json | jq -r '.[0].filename')
# Move to parent directory for release
mv "${TARBALL}" "../${TARBALL}"
# Calculate SHA256 checksum
CHECKSUM=$(sha256sum "../${TARBALL}" | awk '{print $1}')
echo "tarball=${TARBALL}" >> $GITHUB_OUTPUT
echo "checksum=${CHECKSUM}" >> $GITHUB_OUTPUT
echo "Tarball: ${TARBALL}"
echo "Checksum: SHA256:${CHECKSUM}"
- name: Verify tarball contents
id: verify
run: |
TARBALL="${{ steps.tarball.outputs.tarball }}"
echo "Verifying tarball: ${TARBALL}"
# List tarball contents
tar -tzf "${TARBALL}" | head -20
# Verify main.js exists
if ! tar -tzf "${TARBALL}" | grep -q "package/dist/main.js"; then
echo "Error: main.js not found in tarball"
exit 1
fi
# Get file size
SIZE=$(ls -lh "${TARBALL}" | awk '{print $5}')
echo "Size: ${SIZE}"
- name: Create GitHub Release
uses: softprops/action-gh-release@v1
with:
tag_name: ${{ github.ref_name }}
files: ${{ steps.tarball.outputs.tarball }}
generate_release_notes: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Update artifacthub-pkg.yml with checksum
id: update-metadata
run: |
VERSION="${{ steps.version.outputs.version }}"
CHECKSUM="${{ steps.tarball.outputs.checksum }}"
ARCHIVE_URL="https://github.com/${{ github.repository }}/releases/download/v${VERSION}/${{ steps.tarball.outputs.tarball }}"
# Update version, checksum, and archive URL in artifacthub-pkg.yml
python3 << 'EOF'
import yaml
import sys
version = "${{ steps.version.outputs.version }}"
checksum = "${{ steps.tarball.outputs.checksum }}"
archive_url = "$ARCHIVE_URL"
with open('artifacthub-pkg.yml', 'r') as f:
data = yaml.safe_load(f)
# Update version fields
data['version'] = version
data['appVersion'] = version
# Update annotations with archive URL and checksum
data['annotations']['headlamp/plugin/archive-url'] = archive_url
data['annotations']['headlamp/plugin/archive-checksum'] = f'SHA256:{checksum}'
with open('artifacthub-pkg.yml', 'w') as f:
yaml.dump(data, f, sort_keys=False, default_flow_style=False)
print(f"Updated artifacthub-pkg.yml:")
print(f" Version: {version}")
print(f" Checksum: SHA256:{checksum}")
print(f" Archive URL: {archive_url}")
EOF
- name: Verify metadata update
run: |
echo "Updated artifacthub-pkg.yml:"
grep -A 2 "version:" artifacthub-pkg.yml | head -5
grep "archive-url:" artifacthub-pkg.yml
grep "archive-checksum:" artifacthub-pkg.yml
- name: Commit metadata update
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
# Check if there are changes to commit
if git diff --quiet artifacthub-pkg.yml; then
echo "No changes to commit (metadata already up to date)"
else
echo "Committing metadata update..."
git add artifacthub-pkg.yml
git commit -m "chore(release): update checksums for v${{ steps.version.outputs.version }}"
git push origin main
fi
- name: Print release summary
run: |
echo "Release Summary:"
echo "=================="
echo "Version: v${{ steps.version.outputs.version }}"
echo "Tarball: ${{ steps.tarball.outputs.tarball }}"
echo "Checksum: SHA256:${{ steps.tarball.outputs.checksum }}"
echo "Archive URL: https://github.com/${{ github.repository }}/releases/download/v${{ steps.version.outputs.version }}/${{ steps.tarball.outputs.tarball }}"
echo ""
echo "Next: Verify on Artifact Hub (5-10 minutes)"
echo "https://artifacthub.io/packages/headlamp-sealed-secrets"