Action Template

Open source repository template for GitHub actions

Support

Development

• 
• 
• 

---

Menu

• Mission
• Open Source Project
• Features
• Install
• Quickstart
• Examples
• Contributing
• FAQ

Mission

To provide quickstart with open source repository what contains GitHub action

Open Source Project

This is the open source project with GPL-3.0 license. Be free to use, fork, clone and contribute.

Features

• Action files templates
• This template base on libresource/open-source-checklist. It contains may useful files for open source project: (CHECKLIST.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and much more).
• Action example

Install

Just use this repository as GitHub repository template

Quickstart

Run using stable version

Without params

name: Test Action Without Param

on:
  push:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Test Action Without Param
      uses: libresource/action-template@v1.0.0

With params

name: Test Action With Param

on:
  push:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Test Action With Param
      uses: libresource/action-template@v1.0.0
      with:
        param-example: 'Hello GitHub!'

• Change action.yml, Dockerfile and entrypoint.sh
• Change this README.md
• Check all useful files in the project
• Use CHECKLIST.md to check all of you need for good open source project
• Enjoy

Run using last version (maybe unstable)

uses: libresource/action-template@main

Examples

GitHub's repositories which use this template

• action-template (This repository)
• fun-adventure-in-turkey (Visual Novel on RenPy)

Contributing

You are welcome! To easy start please check:

• Contributing
• Code of Conduct
• Security Policy
• Governance
• Support

FAQ

Empty yet