GitHub Action
Version Patcher
Please note that the Action is currently in Beta and is my first project in TypeScript, so some bugs might be present. Bug Reports and Feature Requests are welcome!
VersionPatcher is a simple GitHub Action that helps you patch the version of your projects before compiling your code. It can be considered a replacement for AppVeyor's AssemblyInfo and NET .csproj patching for people moving from AppVeyor to GitHub Actions.
It supports the following project types:
| Programming Language | Project File | Used By | Remarks |
|---|---|---|---|
| C# | *.csproj | msbuild/dotnet | VS 2017 and up only |
| JavaScript/TypeScript | package.json | npm | |
| Python | setup.py | build/setuptools | |
| Python | pyproject.toml | build/setuptools | |
| Python | __init__.py | PEP440 | |
| Lua | fxmanifest.lua | cfx.re Platform | For FiveM, RedM and LibertyM |
| Ruby | *.gemspec | Bundler |
Please note that you need to have an existing dummy version for the script to detect.
To add the action to your workflow, you just add it as step in a job. This is an example of what it should look like:
- name: Patch Versions
uses: justalemon/VersionPatcher@master
with:
version: 1.0.0.${{ github.run_number }}You will need to specify a glob to patch a specific type of version in a specific project. See below for more information.
There are a couple of inputs that you can change to tweak the patching process. They are specified in the with section and they are the following:
| Name | Requirement | Description |
|---|---|---|
| version | required | The version to apply to the patched project, please make sure that the version that you are going to patch is compatible with the versioning used by your package manager |
| trim | optional | If the action will trim the v or V at the beginning of the version before applying it, this is set to true by default (since v0.2) |
| use-tag | optional | If the tag should be used as the version number on Release (since v0.3) |
| csproj-files | optional | The glob to use for finding C# projects, it needs to be compatible with @actions/glob |
| npm-files | optional | The glob to use for finding npm package.json files, it needs to be compatible with @actions/glob |
| setuppy-files | optional | The glob to use for finding Python/SetupTools setup.py files, it needs to be compatible with @actions/glob |
| pyproject-files | optional | The glob to use for finding Python/SetupTools pyproject.toml files, it needs to be compatible with @actions/glob (since v0.7) |
| initpy-files | optional | The glob to use for finding __init__.py files, it needs to be compatible with @actions/glob |
| fxmanifest-files | optional | The glob to use for finding cfx.re fxmanifest.lua files, it needs to be compatible with @actions/glob |
| gemspec-files | optional | The glob to use for finding Bundler gemspec files, it needs to be compatible with @actions/glob (since v0.6) |
There are also a couple of outputs that you can access from your workflow:
| Name | Description |
|---|---|
| version | The trimmed version (without the v/V at the beginning or trailing whitespaces, since v0.4) |