-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use repo name as artifact name to be more generic
- Loading branch information
Showing
2 changed files
with
11 additions
and
5 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
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,11 +1,16 @@ | ||
# Example IPK builder and Release workflow | ||
This repo is meant as an example regarding workflows and IPK's. | ||
This repo is meant as an example regarding workflows and IPKs. | ||
|
||
The `Makefile` is used to build an IPK from the available data. The workflow file is meant to create a new release as soon as a new tag is pushed to the repository. It will thus trigger building the IPK and attaching it to the release. | ||
The `Makefile` is used to build an IPK from the available `control` and `data` directories. The `automation.yml` workflow file is meant to create a new release as soon as a new tag is pushed to the repository. | ||
|
||
> It will thus trigger building the IPK, create a release and attaching the IPK to itt. | ||
## Workflow | ||
Check [automation.yml](./.github/workflows/automation.yml) this file should be pretty self explanatory, there are two jobs: **build** and **release**. | ||
|
||
Both jobs run when something is pushed to master and when new tags are pushed. The **build** job runs the `Makefile` and creates the artifact. The release file fetches the artifact and makes a new release, attaching all available IPK files as assets to the new release. | ||
Both jobs run when something is pushed to master and when new tags are pushed. The **release** job `needs` the **build** job, so it runs first. | ||
|
||
It basically runs the `Makefile` and creates the artifact. The release job fetches the artifact and generates a new release, attaching all available IPK files as assets to the new release. | ||
|
||
When pushed to master the release will be marked as **pre-release**, only when a new tag is pushed it is marked as a full release. | ||
## Tagging | ||
When pushed to master the release will be marked as **pre-release**, only when a new tag is pushed it is marked as a full release, the tag name will then also be the releases name. |