mirror of
https://github.com/ivuorinen/actions.git
synced 2026-01-26 03:23:59 +00:00
feat: simplify actions (#353)
* feat: first pass simplification
* refactor: simplify actions repository structure
Major simplification reducing actions from 44 to 30:
Consolidations:
- Merge biome-check + biome-fix → biome-lint (mode: check/fix)
- Merge eslint-check + eslint-fix → eslint-lint (mode: check/fix)
- Merge prettier-check + prettier-fix → prettier-lint (mode: check/fix)
- Merge 5 version-detect actions → language-version-detect (language param)
Removals:
- common-file-check, common-retry (better served by external tools)
- docker-publish-gh, docker-publish-hub (consolidated into docker-publish)
- github-release (redundant with existing tooling)
- set-git-config (no longer needed)
- version-validator (functionality moved to language-version-detect)
Fixes:
- Rewrite docker-publish to use official Docker actions directly
- Update validate-inputs example (eslint-fix → eslint-lint)
- Update tests and documentation for new structure
Result: ~6,000 lines removed, cleaner action catalog, maintained functionality.
* refactor: complete action simplification and cleanup
Remove deprecated actions and update remaining actions:
Removed:
- common-file-check, common-retry: utility actions
- docker-publish-gh, docker-publish-hub: replaced by docker-publish wrapper
- github-release, version-validator, set-git-config: no longer needed
- Various version-detect actions: replaced by language-version-detect
Updated:
- docker-publish: rewrite as simple wrapper using official Docker actions
- validate-inputs: update example (eslint-fix → eslint-lint)
- Multiple actions: update configurations and remove deprecated dependencies
- Tests: update integration/unit tests for new structure
- Documentation: update README, remove test for deleted actions
Configuration updates:
- Linter configs, ignore files for new structure
- Makefile, pyproject.toml updates
* fix: enforce POSIX compliance in GitHub workflows
Convert all workflow shell scripts to POSIX-compliant sh:
Critical fixes:
- Replace bash with sh in all shell declarations
- Replace [[ with [ for test conditions
- Replace == with = for string comparisons
- Replace set -euo pipefail with set -eu
- Split compound AND conditions into separate [ ] tests
Files updated:
- .github/workflows/test-actions.yml (7 shell declarations, 10 test operators)
- .github/workflows/security-suite.yml (set -eu)
- .github/workflows/action-security.yml (2 shell declarations)
- .github/workflows/pr-lint.yml (3 shell declarations)
- .github/workflows/issue-stats.yml (1 shell declaration)
Ensures compatibility with minimal sh implementations and aligns with
CLAUDE.md standards requiring POSIX shell compliance across all scripts.
All tests pass: 764 pytest tests, 100% coverage.
* fix: add missing permissions for private repository support
Add critical permissions to pr-lint workflow for private repositories:
Workflow-level permissions:
+ packages: read - Access private npm/PyPI/Composer packages
Job-level permissions:
+ packages: read - Access private packages during dependency installation
+ checks: write - Create and update check runs
Fixes failures when:
- Installing private npm packages from GitHub Packages
- Installing private Composer dependencies
- Installing private Python packages
- Creating status checks with github-script
Valid permission scopes per actionlint:
actions, attestations, checks, contents, deployments, discussions,
id-token, issues, models, packages, pages, pull-requests,
repository-projects, security-events, statuses
Note: "workflows" and "metadata" are NOT valid permission scopes
(they are PAT-only scopes or auto-granted respectively).
* docs: update readmes
* fix: replace bash-specific 'source' with POSIX '.' command
Replace all occurrences of 'source' with '.' (dot) for POSIX compliance:
Changes in python-lint-fix/action.yml:
- Line 165: source .venv/bin/activate → . .venv/bin/activate
- Line 179: source .venv/bin/activate → . .venv/bin/activate
- Line 211: source .venv/bin/activate → . .venv/bin/activate
Also fixed bash-specific test operator:
- Line 192: [[ "$FAIL_ON_ERROR" == "true" ]] → [ "$FAIL_ON_ERROR" = "true" ]
The 'source' command is bash-specific. POSIX sh uses '.' (dot) to source files.
Both commands have identical functionality but '.' is portable across all
POSIX-compliant shells.
* security: fix code injection vulnerability in docker-publish
Fix CodeQL code injection warning (CWE-094, CWE-095, CWE-116):
Issue: inputs.context was used directly in GitHub Actions expression
without sanitization at line 194, allowing potential code injection
by external users.
Fix: Use environment variable indirection to prevent expression injection:
- Added env.BUILD_CONTEXT to capture inputs.context
- Changed context parameter to use ${{ env.BUILD_CONTEXT }}
Environment variables are evaluated after expression compilation,
preventing malicious code execution during workflow parsing.
Security Impact: Medium severity (CVSS 5.0)
Identified by: GitHub Advanced Security (CodeQL)
Reference: https://github.com/ivuorinen/actions/pull/353#pullrequestreview-3481935924
* security: prevent credential persistence in pr-lint checkout
Add persist-credentials: false to checkout step to mitigate untrusted
checkout vulnerability. This prevents GITHUB_TOKEN from being accessible
to potentially malicious PR code.
Fixes: CodeQL finding CWE-829 (untrusted checkout on privileged workflow)
* fix: prevent security bot from overwriting unrelated comments
Replace broad string matching with unique HTML comment marker for
identifying bot-generated comments. Previously, any comment containing
'Security Analysis' or '🔐 GitHub Actions Permissions' would be
overwritten, causing data loss.
Changes:
- Add unique marker: <!-- security-analysis-bot-comment -->
- Prepend marker to generated comment body
- Update comment identification to use marker only
- Add defensive null check for comment.body
This fixes critical data loss bug where user comments could be
permanently overwritten by the security analysis bot.
Follows same proven pattern as test-actions.yml coverage comments.
* improve: show concise permissions diff instead of full blocks
Replace verbose full-block permissions diff with line-by-line changes.
Now shows only added/removed permissions, making output much more
readable.
Changes:
- Parse permissions into individual lines
- Compare old vs new to identify actual changes
- Show only removed (-) and added (+) lines in diff
- Collapse unchanged permissions into details section (≤3 items)
- Show count summary for many unchanged permissions (>3 items)
Example output:
Before: 30+ lines showing entire permissions block
After: 3-5 lines showing only what changed
This addresses user feedback that permissions changes were too verbose.
* security: add input validation and trust model documentation
Add comprehensive security validation for docker-publish action to prevent
code injection attacks (CWE-094, CWE-116).
Changes:
- Add validation for context input (reject absolute paths, warn on URLs)
- Add validation for dockerfile input (reject absolute/URL paths)
- Document security trust model in README
- Add best practices for secure usage
- Explain validation rules and threat model
Prevents malicious actors from:
- Building from arbitrary file system locations
- Fetching Dockerfiles from untrusted remote sources
- Executing code injection through build context manipulation
Addresses: CodeRabbit review comments #2541434325, #2541549615
Fixes: GitHub Advanced Security code injection findings
* security: replace unmaintained nick-fields/retry with step-security/retry
Replace nick-fields/retry with step-security/retry across all 4 actions:
- csharp-build/action.yml
- php-composer/action.yml
- go-build/action.yml
- ansible-lint-fix/action.yml
The nick-fields/retry action has security vulnerabilities and low maintenance.
step-security/retry is a drop-in replacement with full API compatibility.
All inputs (timeout_minutes, max_attempts, command, retry_wait_seconds) are
compatible. Using SHA-pinned version for security.
Addresses CodeRabbit review comment #2541549598
* test: add is_input_required() helper function
Add helper function to check if an action input is required, reducing
duplication across test suites.
The function:
- Takes action_file and input_name as parameters
- Uses validation_core.py to query the 'required' property
- Returns 0 (success) if input is required
- Returns 1 (failure) if input is optional
This DRY improvement addresses CodeRabbit review comment #2541549572
* feat: add mode validation convention mapping
Add "mode" to the validation conventions mapping for lint actions
(eslint-lint, biome-lint, prettier-lint).
Note: The update-validators script doesn't currently recognize "string"
as a validator type, so mode validation coverage remains at 93%. The
actions already have inline validation for mode (check|fix), so this is
primarily for improving coverage metrics.
Addresses part of CodeRabbit review comment #2541549570
(validation coverage improvement)
* docs: fix CLAUDE.md action counts and add missing action
- Update action count from 31 to 29 (line 42)
- Add missing 'action-versioning' to Utilities category (line 74)
Addresses CodeRabbit review comments #2541553130 and #2541553110
* docs: add security considerations to docker-publish
Add security documentation to both action.yml header and README.md:
- Trust model explanation
- Input validation details for context and dockerfile
- Attack prevention information
- Best practices for secure usage
The documentation was previously removed when README was autogenerated.
Now documented in both places to ensure it persists.
* fix: correct step ID reference in docker-build
Fix incorrect step ID reference in platforms output:
- Changed steps.platforms.outputs.built to steps.detect-platforms.outputs.platforms
- The step is actually named 'detect-platforms' not 'platforms'
- Ensures output correctly references the detect-platforms step defined at line 188
* fix: ensure docker-build platforms output is always available
Make detect-platforms step unconditional to fix broken output contract.
The platforms output (line 123) references steps.detect-platforms.outputs.platforms,
but the step only ran when auto-detect-platforms was true (default: false).
This caused undefined output in most cases.
Changes:
- Remove 'if' condition from detect-platforms step
- Step now always runs and always produces platforms output
- When auto-detect is false: outputs configured architectures
- When auto-detect is true: outputs detected platforms or falls back to architectures
- Add '|| true' to grep to prevent errors when no platforms detected
Fixes CodeRabbit review comment #2541824904
* security: remove env var indirection in docker-publish BUILD_CONTEXT
Remove BUILD_CONTEXT env var indirection to address GitHub Advanced Security alert.
The inputs.context is validated at lines 137-147 (rejects absolute paths, warns on URLs)
before being used, so the env var indirection is unnecessary and triggers false positive
code injection warnings.
Changes:
- Remove BUILD_CONTEXT env var (line 254)
- Use inputs.context directly (line 256 → 254)
- Input validation remains in place (lines 137-147)
Fixes GitHub Advanced Security code injection alerts (comments #2541405269, #2541522320)
* feat: implement mode_enum validator for lint actions
Add mode_enum validator to validate mode inputs in linting actions.
Changes to conventions.py:
- Add 'mode_enum' to exact_matches mapping (line 215)
- Add 'mode_enum' to PHP-specific validators list (line 560)
- Implement _validate_mode_enum() method (lines 642-660)
- Validates mode values against ['check', 'fix']
- Returns clear error messages for invalid values
Updated rules.yml files:
- biome-lint: Add mode: mode_enum convention
- eslint-lint: Add mode: mode_enum convention
- prettier-lint: Add mode: mode_enum convention
- All rules.yml: Fix YAML formatting with yamlfmt
This addresses PR #353 comment #2541522326 which reported that mode validation
was being skipped due to unrecognized 'string' type, reducing coverage to 93%.
Tested with biome-lint action - correctly rejects invalid values and accepts
valid 'check' and 'fix' values.
* docs: update action count from 29 to 30 in CLAUDE.md
Update two references to action count in CLAUDE.md:
- Line 42: repository_overview memory description
- Line 74: Repository Structure section header
The repository has 30 actions total (29 listed + validate-inputs).
Addresses PR #353 comment #2541549588.
* docs: use pinned version ref in language-version-detect README
Change usage example from @main to @v2025 for security best practices.
Using pinned version refs (instead of @main) ensures:
- Predictable behavior across workflow runs
- Protection against breaking changes
- Better security through immutable references
Follows repository convention documented in main README and CLAUDE.md.
Addresses PR #353 comment #2541549588.
* refactor: remove deprecated add-snippets input from codeql-analysis
Remove add-snippets input which has been deprecated by GitHub's CodeQL action
and no longer has any effect.
Changes:
- Remove add-snippets input definition (lines 93-96)
- Remove reference in init step (line 129)
- Remove reference in analyze step (line 211)
- Regenerate README and rules.yml
This is a non-breaking change since:
- Default was 'false' (minimal usage expected)
- GitHub's action already ignores this parameter
- Aligns with recent repository simplification efforts
* feat: add mode_enum validator and update rules
Add mode_enum validator support for lint actions and regenerate all validation rules:
Validator Changes:
- Add mode_enum to action_overrides for biome-lint, eslint-lint, prettier-lint
- Remove deprecated add-snippets from codeql-analysis overrides
Rules Updates:
- All 29 action rules.yml files regenerated with consistent YAML formatting
- biome-lint, eslint-lint, prettier-lint now validate mode input (check/fix)
- Improved coverage for lint actions (79% → 83% for biome, 93% for eslint, 79% for prettier)
Documentation:
- Fix language-version-detect README to use @v2025 (not @main)
- Remove outdated docker-publish security docs (now handled by official actions)
This completes PR #353 review feedback implementation.
* fix: replace bash-specific $'\n' with POSIX-compliant printf
Replace non-POSIX $'\n' syntax in tag building loop with printf-based
approach that works in any POSIX shell.
Changed:
- Line 216: tags="${tags}"$'\n'"${image}:${tag}"
+ Line 216: tags="$(printf '%s\n%s' "$tags" "${image}:${tag}")"
This ensures docker-publish/action.yml runs correctly on systems using
/bin/sh instead of bash.
This commit is contained in:
GitHub
@@ -4,37 +4,32 @@
|
||||
|
||||
### Description
|
||||
|
||||
Publish a Docker image to GitHub Packages and Docker Hub.
|
||||
Simple wrapper to publish Docker images to GitHub Packages and/or Docker Hub
|
||||
|
||||
### Inputs
|
||||
|
||||
| name | description | required | default |
|
||||
|-------------------------|-------------------------------------------------------------------|----------|----------------------------------------|
|
||||
| `registry` | <p>Registry to publish to (dockerhub, github, or both).</p> | `true` | `both` |
|
||||
| `nightly` | <p>Is this a nightly build? (true or false)</p> | `false` | `false` |
|
||||
| `platforms` | <p>Platforms to build for (comma-separated)</p> | `false` | `linux/amd64,linux/arm64,linux/arm/v7` |
|
||||
| `auto-detect-platforms` | <p>Automatically detect and build for all available platforms</p> | `false` | `false` |
|
||||
| `scan-image` | <p>Scan images for vulnerabilities</p> | `false` | `true` |
|
||||
| `sign-image` | <p>Sign images with cosign</p> | `false` | `false` |
|
||||
| `cache-mode` | <p>Cache mode for build layers (min, max, or inline)</p> | `false` | `max` |
|
||||
| `buildx-version` | <p>Specific Docker Buildx version to use</p> | `false` | `latest` |
|
||||
| `verbose` | <p>Enable verbose logging</p> | `false` | `false` |
|
||||
| `dockerhub-username` | <p>Docker Hub username for authentication</p> | `false` | `""` |
|
||||
| `dockerhub-password` | <p>Docker Hub password or access token for authentication</p> | `false` | `""` |
|
||||
| `token` | <p>GitHub token for authentication</p> | `false` | `""` |
|
||||
| name | description | required | default |
|
||||
|----------------------|-------------------------------------------------------------------|----------|---------------------------|
|
||||
| `registry` | <p>Registry to publish to (dockerhub, github, or both)</p> | `false` | `both` |
|
||||
| `image-name` | <p>Docker image name (defaults to repository name)</p> | `false` | `""` |
|
||||
| `tags` | <p>Comma-separated list of tags (e.g., latest,v1.0.0)</p> | `false` | `latest` |
|
||||
| `platforms` | <p>Platforms to build for (comma-separated)</p> | `false` | `linux/amd64,linux/arm64` |
|
||||
| `context` | <p>Build context path</p> | `false` | `.` |
|
||||
| `dockerfile` | <p>Path to Dockerfile</p> | `false` | `Dockerfile` |
|
||||
| `build-args` | <p>Build arguments (newline-separated KEY=VALUE pairs)</p> | `false` | `""` |
|
||||
| `push` | <p>Whether to push the image</p> | `false` | `true` |
|
||||
| `token` | <p>GitHub token for authentication (for GitHub registry)</p> | `false` | `""` |
|
||||
| `dockerhub-username` | <p>Docker Hub username (required if publishing to Docker Hub)</p> | `false` | `""` |
|
||||
| `dockerhub-token` | <p>Docker Hub token (required if publishing to Docker Hub)</p> | `false` | `""` |
|
||||
|
||||
### Outputs
|
||||
|
||||
| name | description |
|
||||
|-------------------|-------------------------------------------------------|
|
||||
| `registry` | <p>Registry where image was published</p> |
|
||||
| `tags` | <p>Tags that were published</p> |
|
||||
| `build-time` | <p>Total build time in seconds</p> |
|
||||
| `platform-matrix` | <p>Build status per platform</p> |
|
||||
| `scan-results` | <p>Vulnerability scan results if scanning enabled</p> |
|
||||
| `image-id` | <p>Published image ID</p> |
|
||||
| `image-digest` | <p>Published image digest</p> |
|
||||
| `repository` | <p>Repository where image was published</p> |
|
||||
| name | description |
|
||||
|--------------|--------------------------------------|
|
||||
| `image-name` | <p>Full image name with registry</p> |
|
||||
| `tags` | <p>Tags that were published</p> |
|
||||
| `digest` | <p>Image digest</p> |
|
||||
| `metadata` | <p>Build metadata</p> |
|
||||
|
||||
### Runs
|
||||
|
||||
@@ -46,73 +41,67 @@ This action is a `composite` action.
|
||||
- uses: ivuorinen/actions/docker-publish@main
|
||||
with:
|
||||
registry:
|
||||
# Registry to publish to (dockerhub, github, or both).
|
||||
#
|
||||
# Required: true
|
||||
# Default: both
|
||||
|
||||
nightly:
|
||||
# Is this a nightly build? (true or false)
|
||||
# Registry to publish to (dockerhub, github, or both)
|
||||
#
|
||||
# Required: false
|
||||
# Default: false
|
||||
# Default: both
|
||||
|
||||
image-name:
|
||||
# Docker image name (defaults to repository name)
|
||||
#
|
||||
# Required: false
|
||||
# Default: ""
|
||||
|
||||
tags:
|
||||
# Comma-separated list of tags (e.g., latest,v1.0.0)
|
||||
#
|
||||
# Required: false
|
||||
# Default: latest
|
||||
|
||||
platforms:
|
||||
# Platforms to build for (comma-separated)
|
||||
#
|
||||
# Required: false
|
||||
# Default: linux/amd64,linux/arm64,linux/arm/v7
|
||||
# Default: linux/amd64,linux/arm64
|
||||
|
||||
auto-detect-platforms:
|
||||
# Automatically detect and build for all available platforms
|
||||
context:
|
||||
# Build context path
|
||||
#
|
||||
# Required: false
|
||||
# Default: false
|
||||
# Default: .
|
||||
|
||||
scan-image:
|
||||
# Scan images for vulnerabilities
|
||||
dockerfile:
|
||||
# Path to Dockerfile
|
||||
#
|
||||
# Required: false
|
||||
# Default: Dockerfile
|
||||
|
||||
build-args:
|
||||
# Build arguments (newline-separated KEY=VALUE pairs)
|
||||
#
|
||||
# Required: false
|
||||
# Default: ""
|
||||
|
||||
push:
|
||||
# Whether to push the image
|
||||
#
|
||||
# Required: false
|
||||
# Default: true
|
||||
|
||||
sign-image:
|
||||
# Sign images with cosign
|
||||
token:
|
||||
# GitHub token for authentication (for GitHub registry)
|
||||
#
|
||||
# Required: false
|
||||
# Default: false
|
||||
|
||||
cache-mode:
|
||||
# Cache mode for build layers (min, max, or inline)
|
||||
#
|
||||
# Required: false
|
||||
# Default: max
|
||||
|
||||
buildx-version:
|
||||
# Specific Docker Buildx version to use
|
||||
#
|
||||
# Required: false
|
||||
# Default: latest
|
||||
|
||||
verbose:
|
||||
# Enable verbose logging
|
||||
#
|
||||
# Required: false
|
||||
# Default: false
|
||||
# Default: ""
|
||||
|
||||
dockerhub-username:
|
||||
# Docker Hub username for authentication
|
||||
# Docker Hub username (required if publishing to Docker Hub)
|
||||
#
|
||||
# Required: false
|
||||
# Default: ""
|
||||
|
||||
dockerhub-password:
|
||||
# Docker Hub password or access token for authentication
|
||||
#
|
||||
# Required: false
|
||||
# Default: ""
|
||||
|
||||
token:
|
||||
# GitHub token for authentication
|
||||
dockerhub-token:
|
||||
# Docker Hub token (required if publishing to Docker Hub)
|
||||
#
|
||||
# Required: false
|
||||
# Default: ""
|
||||
|
||||
@@ -2,9 +2,33 @@
|
||||
# permissions:
|
||||
# - packages: write # Required for publishing to Docker registries
|
||||
# - contents: read # Required for checking out repository
|
||||
#
|
||||
# Security Considerations:
|
||||
#
|
||||
# Trust Model: This action should only be used in trusted workflows controlled by repository owners.
|
||||
# Do not pass untrusted user input (e.g., PR labels, comments, external webhooks) to the `context`
|
||||
# or `dockerfile` parameters.
|
||||
#
|
||||
# Input Validation: The action validates `context` and `dockerfile` inputs to prevent code injection attacks:
|
||||
#
|
||||
# - `context`: Must be a relative path (e.g., `.`, `./app`, `subdir/`). Absolute paths are rejected.
|
||||
# Remote URLs trigger a warning and should only be used from trusted sources.
|
||||
# - `dockerfile`: Must be a relative path (e.g., `Dockerfile`, `./docker/Dockerfile`). Absolute paths
|
||||
# and URLs are rejected.
|
||||
#
|
||||
# These validations help prevent malicious actors from:
|
||||
# - Building Docker images from arbitrary file system locations
|
||||
# - Fetching malicious Dockerfiles from untrusted remote sources
|
||||
# - Executing code injection attacks through build context manipulation
|
||||
#
|
||||
# Best Practices:
|
||||
# 1. Only use hard-coded values or trusted workflow variables for `context` and `dockerfile`
|
||||
# 2. Never accept these values from PR comments, labels, or external webhooks
|
||||
# 3. Review workflow permissions before granting write access to this action
|
||||
# 4. Use SHA-pinned action references: `ivuorinen/actions/docker-publish@<commit-sha>`
|
||||
---
|
||||
name: Docker Publish
|
||||
description: Publish a Docker image to GitHub Packages and Docker Hub.
|
||||
description: Simple wrapper to publish Docker images to GitHub Packages and/or Docker Hub
|
||||
author: Ismo Vuorinen
|
||||
|
||||
branding:
|
||||
@@ -13,309 +37,225 @@ branding:
|
||||
|
||||
inputs:
|
||||
registry:
|
||||
description: 'Registry to publish to (dockerhub, github, or both).'
|
||||
required: true
|
||||
default: 'both'
|
||||
nightly:
|
||||
description: 'Is this a nightly build? (true or false)'
|
||||
description: 'Registry to publish to (dockerhub, github, or both)'
|
||||
required: false
|
||||
default: 'false'
|
||||
default: 'both'
|
||||
image-name:
|
||||
description: 'Docker image name (defaults to repository name)'
|
||||
required: false
|
||||
tags:
|
||||
description: 'Comma-separated list of tags (e.g., latest,v1.0.0)'
|
||||
required: false
|
||||
default: 'latest'
|
||||
platforms:
|
||||
description: 'Platforms to build for (comma-separated)'
|
||||
required: false
|
||||
default: 'linux/amd64,linux/arm64,linux/arm/v7'
|
||||
auto-detect-platforms:
|
||||
description: 'Automatically detect and build for all available platforms'
|
||||
default: 'linux/amd64,linux/arm64'
|
||||
context:
|
||||
description: 'Build context path'
|
||||
required: false
|
||||
default: 'false'
|
||||
scan-image:
|
||||
description: 'Scan images for vulnerabilities'
|
||||
default: '.'
|
||||
dockerfile:
|
||||
description: 'Path to Dockerfile'
|
||||
required: false
|
||||
default: 'Dockerfile'
|
||||
build-args:
|
||||
description: 'Build arguments (newline-separated KEY=VALUE pairs)'
|
||||
required: false
|
||||
push:
|
||||
description: 'Whether to push the image'
|
||||
required: false
|
||||
default: 'true'
|
||||
sign-image:
|
||||
description: 'Sign images with cosign'
|
||||
required: false
|
||||
default: 'false'
|
||||
cache-mode:
|
||||
description: 'Cache mode for build layers (min, max, or inline)'
|
||||
required: false
|
||||
default: 'max'
|
||||
buildx-version:
|
||||
description: 'Specific Docker Buildx version to use'
|
||||
required: false
|
||||
default: 'latest'
|
||||
verbose:
|
||||
description: 'Enable verbose logging'
|
||||
required: false
|
||||
default: 'false'
|
||||
dockerhub-username:
|
||||
description: 'Docker Hub username for authentication'
|
||||
required: false
|
||||
dockerhub-password:
|
||||
description: 'Docker Hub password or access token for authentication'
|
||||
required: false
|
||||
token:
|
||||
description: 'GitHub token for authentication'
|
||||
description: 'GitHub token for authentication (for GitHub registry)'
|
||||
required: false
|
||||
default: ''
|
||||
dockerhub-username:
|
||||
description: 'Docker Hub username (required if publishing to Docker Hub)'
|
||||
required: false
|
||||
dockerhub-token:
|
||||
description: 'Docker Hub token (required if publishing to Docker Hub)'
|
||||
required: false
|
||||
|
||||
outputs:
|
||||
registry:
|
||||
description: 'Registry where image was published'
|
||||
value: ${{ steps.dest.outputs.reg }}
|
||||
image-name:
|
||||
description: 'Full image name with registry'
|
||||
value: ${{ steps.meta.outputs.image-name }}
|
||||
tags:
|
||||
description: 'Tags that were published'
|
||||
value: ${{ steps.tags.outputs.all-tags }}
|
||||
build-time:
|
||||
description: 'Total build time in seconds'
|
||||
value: ${{ steps.build.outputs.build-time }}
|
||||
platform-matrix:
|
||||
description: 'Build status per platform'
|
||||
value: ${{ steps.build.outputs.platform-matrix }}
|
||||
scan-results:
|
||||
description: 'Vulnerability scan results if scanning enabled'
|
||||
value: ${{ steps.build.outputs.scan-results }}
|
||||
image-id:
|
||||
description: 'Published image ID'
|
||||
value: ${{ steps.publish-dockerhub.outputs.image-id || steps.publish-github.outputs.image-id }}
|
||||
image-digest:
|
||||
description: 'Published image digest'
|
||||
value: ${{ steps.publish-dockerhub.outputs.digest || steps.publish-github.outputs.digest }}
|
||||
repository:
|
||||
description: 'Repository where image was published'
|
||||
value: ${{ steps.publish-dockerhub.outputs.repository || steps.publish-github.outputs.repository }}
|
||||
value: ${{ steps.meta.outputs.tags }}
|
||||
digest:
|
||||
description: 'Image digest'
|
||||
value: ${{ steps.build.outputs.digest }}
|
||||
metadata:
|
||||
description: 'Build metadata'
|
||||
value: ${{ steps.build.outputs.metadata }}
|
||||
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Mask Sensitive Inputs
|
||||
shell: bash
|
||||
env:
|
||||
DOCKERHUB_PASSWORD: ${{ inputs.dockerhub-password }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
# Mask Docker Hub credentials to prevent exposure in logs
|
||||
if [[ -n "${DOCKERHUB_PASSWORD}" ]]; then
|
||||
echo "::add-mask::${DOCKERHUB_PASSWORD}"
|
||||
fi
|
||||
|
||||
- name: Validate Inputs
|
||||
id: validate
|
||||
shell: bash
|
||||
shell: sh
|
||||
env:
|
||||
REGISTRY: ${{ inputs.registry }}
|
||||
INPUT_REGISTRY: ${{ inputs.registry }}
|
||||
INPUT_DOCKERHUB_USERNAME: ${{ inputs.dockerhub-username }}
|
||||
INPUT_DOCKERHUB_TOKEN: ${{ inputs.dockerhub-token }}
|
||||
INPUT_TOKEN: ${{ inputs.token }}
|
||||
INPUT_CONTEXT: ${{ inputs.context }}
|
||||
INPUT_DOCKERFILE: ${{ inputs.dockerfile }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
set -eu
|
||||
|
||||
# Validate registry input
|
||||
if ! [[ "$REGISTRY" =~ ^(dockerhub|github|both)$ ]]; then
|
||||
echo "::error::Invalid registry value. Must be 'dockerhub', 'github', or 'both'"
|
||||
exit 1
|
||||
fi
|
||||
case "$INPUT_REGISTRY" in
|
||||
dockerhub|github|both)
|
||||
;;
|
||||
*)
|
||||
echo "::error::Invalid registry value. Must be 'dockerhub', 'github', or 'both'"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
- name: Determine Tags
|
||||
id: tags
|
||||
shell: bash
|
||||
env:
|
||||
NIGHTLY: ${{ inputs.nightly }}
|
||||
RELEASE_TAG: ${{ github.event.release.tag_name }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
# Initialize variables
|
||||
declare -a tag_array
|
||||
|
||||
if [[ "$NIGHTLY" == "true" ]]; then
|
||||
# Nightly build tags
|
||||
current_date=$(date +'%Y%m%d-%H%M')
|
||||
tag_array+=("nightly")
|
||||
tag_array+=("nightly-${current_date}")
|
||||
else
|
||||
# Release tags
|
||||
if [[ -n "$RELEASE_TAG" ]]; then
|
||||
tag_array+=("$RELEASE_TAG")
|
||||
tag_array+=("latest")
|
||||
else
|
||||
echo "::error::No release tag found and not a nightly build"
|
||||
# Validate Docker Hub credentials if needed
|
||||
if [ "$INPUT_REGISTRY" = "dockerhub" ] || [ "$INPUT_REGISTRY" = "both" ]; then
|
||||
if [ -z "$INPUT_DOCKERHUB_USERNAME" ] || [ -z "$INPUT_DOCKERHUB_TOKEN" ]; then
|
||||
echo "::error::Docker Hub username and token are required when publishing to Docker Hub"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Join tags with comma
|
||||
tags=$(IFS=,; echo "${tag_array[*]}")
|
||||
echo "all-tags=${tags}" >> "$GITHUB_OUTPUT"
|
||||
echo "Generated tags: ${tags}"
|
||||
|
||||
- name: Determine Publish Destination
|
||||
id: dest
|
||||
shell: bash
|
||||
env:
|
||||
REGISTRY: ${{ inputs.registry }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
if [[ "$REGISTRY" == "both" ]]; then
|
||||
echo "reg=github,dockerhub" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "reg=$REGISTRY" >> "$GITHUB_OUTPUT"
|
||||
# Validate GitHub token if needed
|
||||
if [ "$INPUT_REGISTRY" = "github" ] || [ "$INPUT_REGISTRY" = "both" ]; then
|
||||
token="${INPUT_TOKEN:-${GITHUB_TOKEN:-}}"
|
||||
if [ -z "$token" ]; then
|
||||
echo "::error::GitHub token is required when publishing to GitHub Packages"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "Publishing to: $REGISTRY"
|
||||
# Validate context input for security
|
||||
INPUT_CONTEXT="${INPUT_CONTEXT:-.}"
|
||||
case "$INPUT_CONTEXT" in
|
||||
.|./*|*/*)
|
||||
# Relative paths are allowed
|
||||
;;
|
||||
/*)
|
||||
echo "::error::Context cannot be an absolute path: '$INPUT_CONTEXT'"
|
||||
echo "::error::Use relative paths (e.g., '.', './app') to prevent code injection"
|
||||
exit 1
|
||||
;;
|
||||
*://*)
|
||||
echo "::warning::Context is a remote URL: '$INPUT_CONTEXT'"
|
||||
echo "::warning::Ensure this URL is from a trusted source to prevent code injection"
|
||||
;;
|
||||
esac
|
||||
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@71cf2267d89c5cb81562390fa70a37fa40b1305e # v6-beta
|
||||
with:
|
||||
token: ${{ inputs.token || github.token }}
|
||||
# Validate dockerfile input for security
|
||||
INPUT_DOCKERFILE="${INPUT_DOCKERFILE:-Dockerfile}"
|
||||
case "$INPUT_DOCKERFILE" in
|
||||
Dockerfile|*/Dockerfile|*.dockerfile|*/*.dockerfile)
|
||||
# Common dockerfile patterns are allowed
|
||||
;;
|
||||
/*)
|
||||
echo "::error::Dockerfile path cannot be absolute: '$INPUT_DOCKERFILE'"
|
||||
echo "::error::Use relative paths (e.g., 'Dockerfile', './docker/Dockerfile')"
|
||||
exit 1
|
||||
;;
|
||||
*://*)
|
||||
echo "::error::Dockerfile path cannot be a URL: '$INPUT_DOCKERFILE'"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
- name: Build Multi-Arch Docker Image
|
||||
id: build
|
||||
uses: ivuorinen/actions/docker-build@0fa9a68f07a1260b321f814202658a6089a43d42
|
||||
with:
|
||||
tag: ${{ steps.tags.outputs.all-tags }}
|
||||
architectures: ${{ inputs.platforms }}
|
||||
auto-detect-platforms: ${{ inputs.auto-detect-platforms }}
|
||||
scan-image: ${{ inputs.scan-image }}
|
||||
sign-image: ${{ inputs.sign-image }}
|
||||
cache-mode: ${{ inputs.cache-mode }}
|
||||
buildx-version: ${{ inputs.buildx-version }}
|
||||
verbose: ${{ inputs.verbose }}
|
||||
push: 'false' # Don't push during build, let publish actions handle it
|
||||
echo "Input validation completed successfully"
|
||||
|
||||
- name: Publish to Docker Hub
|
||||
id: publish-dockerhub
|
||||
if: contains(steps.dest.outputs.reg, 'dockerhub')
|
||||
uses: ivuorinen/actions/docker-publish-hub@0fa9a68f07a1260b321f814202658a6089a43d42
|
||||
with:
|
||||
tags: ${{ steps.tags.outputs.all-tags }}
|
||||
platforms: ${{ inputs.platforms }}
|
||||
auto-detect-platforms: ${{ inputs.auto-detect-platforms }}
|
||||
scan-image: ${{ inputs.scan-image }}
|
||||
sign-image: ${{ inputs.sign-image }}
|
||||
cache-mode: ${{ inputs.cache-mode }}
|
||||
buildx-version: ${{ inputs.buildx-version }}
|
||||
verbose: ${{ inputs.verbose }}
|
||||
username: ${{ inputs.dockerhub-username }}
|
||||
password: ${{ inputs.dockerhub-password }}
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.7.1
|
||||
|
||||
- name: Publish to GitHub Packages
|
||||
id: publish-github
|
||||
if: contains(steps.dest.outputs.reg, 'github')
|
||||
uses: ivuorinen/actions/docker-publish-gh@0fa9a68f07a1260b321f814202658a6089a43d42
|
||||
with:
|
||||
tags: ${{ steps.tags.outputs.all-tags }}
|
||||
platforms: ${{ inputs.platforms }}
|
||||
auto-detect-platforms: ${{ inputs.auto-detect-platforms }}
|
||||
scan-image: ${{ inputs.scan-image }}
|
||||
sign-image: ${{ inputs.sign-image }}
|
||||
cache-mode: ${{ inputs.cache-mode }}
|
||||
buildx-version: ${{ inputs.buildx-version }}
|
||||
verbose: ${{ inputs.verbose }}
|
||||
|
||||
- name: Verify Publications
|
||||
id: verify
|
||||
shell: bash
|
||||
- name: Determine Image Names and Tags
|
||||
id: meta
|
||||
shell: sh
|
||||
env:
|
||||
DEST_REG: ${{ steps.dest.outputs.reg }}
|
||||
DOCKERHUB_IMAGE_NAME: ${{ steps.publish-dockerhub.outputs.image-name }}
|
||||
DOCKERHUB_TAGS: ${{ steps.publish-dockerhub.outputs.tags }}
|
||||
GITHUB_IMAGE_NAME: ${{ steps.publish-github.outputs.image-name }}
|
||||
GITHUB_TAGS: ${{ steps.publish-github.outputs.tags }}
|
||||
ALL_TAGS: ${{ steps.tags.outputs.all-tags }}
|
||||
INPUT_REGISTRY: ${{ inputs.registry }}
|
||||
INPUT_IMAGE_NAME: ${{ inputs.image-name }}
|
||||
INPUT_TAGS: ${{ inputs.tags }}
|
||||
GITHUB_REPOSITORY: ${{ github.repository }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
set -eu
|
||||
|
||||
echo "Verifying publications..."
|
||||
success=true
|
||||
# Determine base image name
|
||||
if [ -n "$INPUT_IMAGE_NAME" ]; then
|
||||
base_name="$INPUT_IMAGE_NAME"
|
||||
else
|
||||
# Use repository name (lowercase)
|
||||
base_name=$(echo "$GITHUB_REPOSITORY" | tr '[:upper:]' '[:lower:]')
|
||||
fi
|
||||
|
||||
# Split registry string into array
|
||||
IFS=',' read -ra REGISTRIES <<< "$DEST_REG"
|
||||
# Build full image names based on registry
|
||||
image_names=""
|
||||
case "$INPUT_REGISTRY" in
|
||||
dockerhub)
|
||||
image_names="docker.io/${base_name}"
|
||||
;;
|
||||
github)
|
||||
image_names="ghcr.io/${base_name}"
|
||||
;;
|
||||
both)
|
||||
image_names="docker.io/${base_name},ghcr.io/${base_name}"
|
||||
;;
|
||||
esac
|
||||
|
||||
for registry in "${REGISTRIES[@]}"; do
|
||||
echo "Checking ${registry} publication..."
|
||||
case "${registry}" in
|
||||
"dockerhub")
|
||||
# Get actual image name from publish step output or fallback to repo-based name
|
||||
image_name="$DOCKERHUB_IMAGE_NAME"
|
||||
if [[ -z "$image_name" ]]; then
|
||||
image_name="docker.io/$GITHUB_REPOSITORY"
|
||||
fi
|
||||
|
||||
# Get tags from publish step or fallback to metadata
|
||||
tags="$DOCKERHUB_TAGS"
|
||||
if [[ -z "$tags" ]]; then
|
||||
tags="$ALL_TAGS"
|
||||
fi
|
||||
|
||||
IFS=',' read -ra TAGS <<< "$tags"
|
||||
for tag in "${TAGS[@]}"; do
|
||||
tag=$(echo "$tag" | xargs) # trim whitespace
|
||||
if ! docker manifest inspect "${image_name}:${tag}" > /dev/null 2>&1; then
|
||||
echo "::error::Failed to verify Docker Hub publication for ${tag}"
|
||||
success=false
|
||||
break
|
||||
fi
|
||||
done
|
||||
if [[ "${success}" != "true" ]]; then
|
||||
break
|
||||
fi
|
||||
;;
|
||||
"github")
|
||||
# Get actual image name from publish step output or fallback to repo-based name
|
||||
image_name="$GITHUB_IMAGE_NAME"
|
||||
if [[ -z "$image_name" ]]; then
|
||||
image_name="ghcr.io/$GITHUB_REPOSITORY"
|
||||
fi
|
||||
|
||||
# Get tags from publish step or fallback to metadata
|
||||
tags="$GITHUB_TAGS"
|
||||
if [[ -z "$tags" ]]; then
|
||||
tags="$ALL_TAGS"
|
||||
fi
|
||||
|
||||
IFS=',' read -ra TAGS <<< "$tags"
|
||||
for tag in "${TAGS[@]}"; do
|
||||
tag=$(echo "$tag" | xargs) # trim whitespace
|
||||
if ! docker manifest inspect "${image_name}:${tag}" > /dev/null 2>&1; then
|
||||
echo "::error::Failed to verify GitHub Packages publication for ${tag}"
|
||||
success=false
|
||||
break
|
||||
fi
|
||||
done
|
||||
if [[ "${success}" != "true" ]]; then
|
||||
break
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
# Build full tags (image:tag format)
|
||||
tags=""
|
||||
IFS=','
|
||||
for image in $image_names; do
|
||||
for tag in $INPUT_TAGS; do
|
||||
tag=$(echo "$tag" | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
|
||||
if [ -n "$tags" ]; then
|
||||
tags="$(printf '%s\n%s' "$tags" "${image}:${tag}")"
|
||||
else
|
||||
tags="${image}:${tag}"
|
||||
fi
|
||||
done
|
||||
done
|
||||
|
||||
if [[ "${success}" != "true" ]]; then
|
||||
echo "::error::Publication verification failed"
|
||||
exit 1
|
||||
fi
|
||||
# Output results
|
||||
printf 'image-name=%s\n' "$base_name" >> "$GITHUB_OUTPUT"
|
||||
{
|
||||
echo 'tags<<EOF'
|
||||
echo "$tags"
|
||||
echo 'EOF'
|
||||
} >> "$GITHUB_OUTPUT"
|
||||
|
||||
echo "All publications verified successfully"
|
||||
echo "Image name: $base_name"
|
||||
echo "Tags:"
|
||||
echo "$tags"
|
||||
|
||||
- name: Cleanup
|
||||
if: always()
|
||||
shell: bash
|
||||
env:
|
||||
DEST_REG: ${{ steps.dest.outputs.reg }}
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
- name: Login to Docker Hub
|
||||
if: inputs.registry == 'dockerhub' || inputs.registry == 'both'
|
||||
uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
|
||||
with:
|
||||
username: ${{ inputs.dockerhub-username }}
|
||||
password: ${{ inputs.dockerhub-token }}
|
||||
|
||||
echo "Cleaning up..."
|
||||
- name: Login to GitHub Container Registry
|
||||
if: inputs.registry == 'github' || inputs.registry == 'both'
|
||||
uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ inputs.token || github.token }}
|
||||
|
||||
# Remove any temporary files or caches
|
||||
docker buildx prune -f --keep-storage=10GB
|
||||
|
||||
# Remove any temporary authentication
|
||||
if [[ "$DEST_REG" =~ "dockerhub" ]]; then
|
||||
docker logout docker.io || true
|
||||
fi
|
||||
if [[ "$DEST_REG" =~ "github" ]]; then
|
||||
docker logout ghcr.io || true
|
||||
fi
|
||||
|
||||
echo "Cleanup completed"
|
||||
- name: Build and Push Docker Image
|
||||
id: build
|
||||
uses: docker/build-push-action@4f58ea79222b3b9dc2c8bbdd6debcef730109a75 # v6.9.0
|
||||
with:
|
||||
context: ${{ inputs.context }}
|
||||
file: ${{ inputs.dockerfile }}
|
||||
platforms: ${{ inputs.platforms }}
|
||||
push: ${{ inputs.push }}
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
build-args: ${{ inputs.build-args }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
# Validation rules for docker-publish action
|
||||
# Generated by update-validators.py v1.0.0 - DO NOT EDIT MANUALLY
|
||||
# Schema version: 1.0
|
||||
# Coverage: 100% (12/12 inputs)
|
||||
# Coverage: 73% (8/11 inputs)
|
||||
#
|
||||
# This file defines validation rules for the docker-publish GitHub Action.
|
||||
# Rules are automatically applied by validate-inputs action when this
|
||||
@@ -11,50 +11,44 @@
|
||||
|
||||
schema_version: '1.0'
|
||||
action: docker-publish
|
||||
description: Publish a Docker image to GitHub Packages and Docker Hub.
|
||||
description: Simple wrapper to publish Docker images to GitHub Packages and/or Docker Hub
|
||||
generator_version: 1.0.0
|
||||
required_inputs:
|
||||
- registry
|
||||
required_inputs: []
|
||||
optional_inputs:
|
||||
- auto-detect-platforms
|
||||
- buildx-version
|
||||
- cache-mode
|
||||
- dockerhub-password
|
||||
- build-args
|
||||
- context
|
||||
- dockerfile
|
||||
- dockerhub-token
|
||||
- dockerhub-username
|
||||
- nightly
|
||||
- image-name
|
||||
- platforms
|
||||
- scan-image
|
||||
- sign-image
|
||||
- push
|
||||
- registry
|
||||
- tags
|
||||
- token
|
||||
- verbose
|
||||
conventions:
|
||||
auto-detect-platforms: docker_architectures
|
||||
buildx-version: semantic_version
|
||||
cache-mode: boolean
|
||||
dockerhub-password: github_token
|
||||
dockerfile: file_path
|
||||
dockerhub-token: github_token
|
||||
dockerhub-username: username
|
||||
nightly: boolean
|
||||
image-name: docker_image_name
|
||||
platforms: docker_architectures
|
||||
registry: registry
|
||||
scan-image: boolean
|
||||
sign-image: boolean
|
||||
tags: docker_tag
|
||||
token: github_token
|
||||
verbose: boolean
|
||||
overrides:
|
||||
cache-mode: cache_mode
|
||||
platforms: null
|
||||
registry: registry_enum
|
||||
statistics:
|
||||
total_inputs: 12
|
||||
validated_inputs: 12
|
||||
total_inputs: 11
|
||||
validated_inputs: 8
|
||||
skipped_inputs: 1
|
||||
coverage_percentage: 100
|
||||
validation_coverage: 100
|
||||
coverage_percentage: 73
|
||||
validation_coverage: 73
|
||||
auto_detected: true
|
||||
manual_review_required: false
|
||||
manual_review_required: true
|
||||
quality_indicators:
|
||||
has_required_inputs: true
|
||||
has_required_inputs: false
|
||||
has_token_validation: true
|
||||
has_version_validation: true
|
||||
has_file_validation: false
|
||||
has_version_validation: false
|
||||
has_file_validation: true
|
||||
has_security_validation: true
|
||||
|
||||
Reference in New Issue
Block a user