-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f4fded2
commit 7aef5de
Showing
1 changed file
with
11 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,15 @@ | ||
# Bash Action Template | ||
|
||
A template for a [custom GitHub action](https://docs.github.com/en/actions/creating-actions/about-custom-actions) that runs a bash script. This is a [composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) that runs the `run.sh` script to execute the custom GitHub action logic. Since it's a composite action, you can still add other steps such as calling other GitHub actions or running code in a `- run: ...` block. | ||
A template for a [custom GitHub action](https://docs.github.com/en/actions/creating-actions/about-custom-actions) that runs a bash script. This is a [composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) that runs the `run.sh` script to execute custom logic for the action. Since it's a composite action, you can still add other steps such as calling other GitHub actions or running code in a `- run: ...` block. | ||
|
||
## Usage | ||
Click the green `Use this template` button, `Create a new repository`, fill in your new repo's information and start developing your action! | ||
|
||
There is some metadata in the `action.yml` file you'll want to change when your ready to release your action to the marketplace. If you create many GitHub actions, feel free to fork this repo and edit the metadata, then create your actions from the forked template. This will reduce the amount configuration steps when creating new actions. | ||
|
||
### Note | ||
The GitHub workflow **'Initialize'** runs after creating a new repository from this template. The workflow will: | ||
- Clear `README.md` file. | ||
- Leaves only a heading with your new repo's name. | ||
- The `LICENSE` file is deleted. | ||
- The `FUNDING.yml` file is deleted if the user who created the repo does not own the template. | ||
- If you fork this template and create a new action with it, the FUNDING.yml file is preserved. | ||
- The workflow's `initialize.yml` file is deleted. | ||
- To prevent initializing repo again. | ||
- Changes are committed and pushed back to GitHub. | ||
1. Click the green **Use this template** button then **Create a new repository** | ||
2. Fill in your new repo's information and click **Create repository from template** | ||
3. The **Initialize** workflow will be trigger which will: | ||
- Replace the README.md text with a heading of you action's name based on the repo name | ||
- Remove the current license | ||
- Update the following entries in the action.yml file | ||
- 'name' is set to your action's name based on the repo's name | ||
- 'author' is set to the name of the repo's owner | ||
- 'description' is set to the description provided when creating the new repo | ||
- Delete the initialization.yml workflow file |