Skip to content

devops-infra/template-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

πŸš€ GitHub Action template

Template repository for GitHub Actions

πŸ“¦ Available on

✨ Features

  • Baseline for Dockerfile, entrypoint.sh, Makefile.
  • Templates for Pull Requests and Issues.
  • Actions for a default automation.
  • Includes Code of Conduct, Contributing and Codeowners.

πŸ“Š Badge Swag

GitHub repo GitHub code size in bytes GitHub last commit GitHub license
DockerHub Docker version Image size Docker Pulls

πŸ“– API Reference

    - name: Run the Action
      uses: devops-infra/[email protected]
      env:
        bazbar: barfoo
      with:
        foobar: bazbar

πŸ”§ Input Parameters

Environment Variable Required Description
bazbar No Environment variable for env: ....
Input Variable Required Default Description
foobar No foobar Some input variable for with: ....

πŸ“€ Output Parameters

Outputs Description
foobar Output from action.

πŸ’» Usage Examples

πŸ“ Basic Example

Run the Action with defaults.

      - name: Run the Action
        uses: devops-infra/[email protected]

πŸ”€ Advanced Example

Run the Action with set inputs.

name: Run the Action on each commit
on:
  push
jobs:
  template-action:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v5
      - name: Run the Action
        uses: devops-infra/[email protected]
        env:
          bar: foo
        with:
          bar: baz

🏷️ Version Tags: vX, vX.Y, vX.Y.Z

This action supports three tag levels for flexible versioning:

  • vX: Always points to the latest patch of a major version (e.g., v1 β†’ v1.2.3).
    Benefit: Get all latest fixes for a major version automatically.

  • vX.Y: Always points to the latest patch of a minor version (e.g., v1.2 β†’ v1.2.3).
    Benefit: Stay on a minor version, always up-to-date with bugfixes.

  • vX.Y.Z: Fixed to a specific release (e.g., v1.2.3).
    Benefit: Full reproducibilityβ€”never changes.

Use the tag depth that matches your stability needs.

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. Refer to the CONTRIBUTING for guidelines.

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ’¬ Support

If you have any questions or need help, please:

  • πŸ“ Create an issue
  • 🌟 Star this repository if you find it useful!