https://github.com/0ad-matters/gh-action-build-pyromod
GitHub Action that builds a @0ad pyromod file
https://github.com/0ad-matters/gh-action-build-pyromod
0ad game-ci github-actions-docker mods pyromod
Last synced: about 2 months ago
JSON representation
GitHub Action that builds a @0ad pyromod file
- Host: GitHub
- URL: https://github.com/0ad-matters/gh-action-build-pyromod
- Owner: 0ad-matters
- License: gpl-3.0
- Created: 2022-09-23T04:16:50.000Z (almost 3 years ago)
- Default Branch: trunk
- Last Pushed: 2024-10-18T16:11:41.000Z (8 months ago)
- Last Synced: 2024-11-17T03:49:01.577Z (7 months ago)
- Topics: 0ad, game-ci, github-actions-docker, mods, pyromod
- Language: Shell
- Homepage:
- Size: 60.5 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: COPYING
Awesome Lists containing this project
README
# GitHub Action to build a 0ad pyromod file
This is a [GitHub Action](https://github.com/features/actions) that
will build a [0ad
pyromod](https://trac.wildfiregames.com/wiki/Modding_Guide#Distributingyourmods).
## Usage
If your mod is not in the root directory of your repository, you can
add the 'directory' argument (see option table below) after 'with:' to
specify the relative path.
The example shown below has two separate jobs:
1. When there is a push to the default branch, or when a pull request
is opened or updated, the pyromod is built and is uploaded to the
workflow output page.
2. When a new a new tag is created (if the tag starts with a 'v'), the
built mod will get uploaded to the release page, along with a
corresponding sha256sum.
This file needs to be placed in
/.github/workflows/.yml
(where `` can be anything you like)
The [release action](https://github.com/ncipollo/release-action) used
in the example below is a separate action (not maintained by this
project) and can be replaced by a different release action if you
like.
```yaml
name: Build Pyromod
on:
push:
branches:
- main
tags:
- v**
pull_request:
branches:
- main
env:
MOD_NAME:
jobs:
build-pyromod:
if: ${{ github.ref_type != 'tag' }}
runs-on: ubuntu-latest
env:
MOD_VERSION: ${{ github.sha }}
steps:
- uses: actions/checkout@v4
- uses: 0ad-matters/gh-action-build-pyromod@v2
with:
name: ${{ env.MOD_NAME }}
version: ${{ env.MOD_VERSION }}
id: build-pyromod
- name: Upload Artifacts
# Uploads artifacts (combined into a zip file) to the workflow output page
uses: actions/upload-artifact@v3
with:
name: ${{ env.MOD_NAME }}-${{ env.MOD_VERSION }}
path: "output/${{ env.MOD_NAME }}*.*"
release-pyromod:
if: ${{ github.ref_type == 'tag' }}
runs-on: ubuntu-latest
env:
MOD_VERSION: ${{ github.ref_name }}
steps:
- uses: actions/checkout@v4
- name: Massage Variables
run: |
echo "MOD_VERSION=${MOD_VERSION:1}" >> $GITHUB_ENV
- uses: 0ad-matters/gh-action-build-pyromod@v2
with:
name: ${{ env.MOD_NAME }}
version: ${{ env.MOD_VERSION }}
id: build-pyromod
- name: Create sha256sum
run: |
OUTPUT_FILE="$MOD_NAME-$MOD_VERSION.pyromod"
cd output
sha256sum $OUTPUT_FILE > $OUTPUT_FILE.sha256sum
- name: Release PyroMod
uses: ncipollo/release-action@v1
with:
allowUpdates: True
prerelease: False
artifacts: "output/${{ env.MOD_NAME }}*.*"
token: ${{ secrets.GITHUB_TOKEN }}
omitNameDuringUpdate: True
omitBodyDuringUpdate: True
```
## Option table
| name | required | description | default |
|----------|--------|-------------|--------|
| name | true | | |
| version | true | | |
| directory | false | relative path to your mod.json file | '.' |
| remove_from_pyromod | false | list of files or directories to remove, each separated by a space (wildcards ok) | |
Note that this action will remove '.git*' from the pyromod by default
and doesn't need to be added to the 'remove_from_pyromod' string.
remove_from_pyromod example:
remove_from_pyromod: 'foo bar /package.json /.*'
## Additional Notes
Option table
The docker image used by this action is published from
[0ad-matters/0ad-bin-nodata](https://github.com/0ad-matters/0ad-bin-nodata)
and pulled from
[andy5995/0ad-bin-nodata](https://hub.docker.com/repository/docker/andy5995/0ad-bin-nodata).