https://github.com/faulo/jenkins-unity
https://github.com/faulo/jenkins-unity
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/faulo/jenkins-unity
- Owner: Faulo
- Created: 2022-12-30T16:27:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T16:45:56.000Z (over 1 year ago)
- Last Synced: 2024-04-14T06:57:31.716Z (over 1 year ago)
- Language: Groovy
- Size: 132 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Unity Commands for Jenkins
This repository adds build commands for Unity to a Jenkins pipeline context.
### Prerequisites
The Jenkins server needs access to a node tagged with the label `unity`. That node needs the environment variable `COMPOSE_UNITY`, which should point to a working installation of the composer package [slothsoft/unity](https://github.com/Faulo/slothsoft-unity). (On Linux, this would be something like `composer -d /var/unity exec`, whereas on Windows, it could be `composer -d C:\Webserver\unity exec`. Consult that package for information on how to handle Unity licenses.)
## Usage
All of these commands need to be placed inside a `node` block of the iterative or a `steps` block of the declarative Jenkins pipeline.
All values are optional and default to the first value from among the possible values below.
### The `unityProject` command
This command locates a Unity project inside the repository, updates the project version, runs its unit tests, builds executables, and (if successful) deploys the executables to either Steam or itch.io.
```groovy
unityProject {
// Relative path to the Unity project inside the repository.
LOCATION = ''
// Automatically set the version of the Unity project based on the tags and commits of the VCS. Can be '' (disabled), 'git' or 'plastic'.
AUTOVERSION = ''
// Automatically append the build number to the version of the project.
AUTOVERSION_REVISION = '0'
AUTOVERSION_REVISION_PREFIX = ''
AUTOVERSION_REVISION_SUFFIX = ''
// Assert that the C# code of the package matches the .editorconfig.
TEST_FORMATTING = '0'
EDITORCONFIG_LOCATION = '.editorconfig'
FORMATTING_EXCLUDE = ''
// Assert Unity's Test Runner tests.
TEST_UNITY = '0'
TEST_MODES = 'EditMode PlayMode'
// Automatically create C# docs using DocFX
BUILD_DOCUMENTATION = '0'
// Which executables to create. Note that WebGL and Android can only be built if the project contains the "Slothsoft's UnityExtensions" package.
BUILD_FOR_WINDOWS = '0'
BUILD_FOR_LINUX = '0'
BUILD_FOR_MAC = '0'
BUILD_FOR_WEBGL = '0'
BUILD_FOR_ANDROID = '0'
BUILD_NAME = ''
// Deploy the executables to the Steam server.
DEPLOY_TO_STEAM = '0'
// The Jenkins credentials to use for Steam deployment. These will be fed to `steamcmd` and should consist of user name and password.
STEAM_CREDENTIALS = ''
// The Steam App ID to deploy to.
STEAM_ID = ''
// The Steam Depot ID to deploy the Windows executable to.
STEAM_DEPOT_WINDOWS = ''
// The Steam Depot ID to deploy the Linux executable to.
STEAM_DEPOT_LINUX = ''
// The Steam Depot ID to deploy the MacOS executable to.
STEAM_DEPOT_MAC = ''
// The Steam branch to deploy to. Defaults to the current VCS branch with all slashes replaced with dashes ('/main/feature' becomes 'main-feature').
STEAM_BRANCH = ''
// Deploy the executables to the itch.io server.
DEPLOY_TO_ITCH = '0'
// The Jenkins credentials to use for itch.io deployment. These will be fed to `butler` and should consist of an authentification token.
ITCH_CREDENTIALS = ''
// The ID of the itch.io page (usually consists of '${author}/${game}').
ITCH_ID = ''
// Only attempt to deploy if the current VCS branch is among the branches listed. Note that Plastic's branches start with a slash.
DEPLOYMENT_BRANCHES = ['main', '/main']
// Report the build status to a Discord Webhook.
REPORT_TO_DISCORD = '0'
DISCORD_WEBHOOK = 'https://discord.com/api/webhooks/etc'
// Report the build status to a Microsoft Office 365 Webhook.
REPORT_TO_OFFICE_365 = '0'
OFFICE_365_WEBHOOK = 'https://webhook.office.com/etc'
}
```
### The `unityPackage` command
This command locates a Unity package inside the repository, runs its unit tests, and (if successful) deploys it to a Verdaccio server.
```groovy
unityPackage {
// Define Unity package location relative to repository.
LOCATION = ''
// If given, use this package information instead of reading from the package's package.json.
ID = ''
VERSION = ''
// Assert that CHANGELOG.md has been updated.
TEST_CHANGELOG = '1'
CHANGELOG_LOCATION = 'CHANGELOG.md'
// Assert that the C# code of the package matches the .editorconfig.
TEST_FORMATTING = '0'
EDITORCONFIG_LOCATION = '.editorconfig'
FORMATTING_EXCLUDE = ''
// Assert Unity's Test Runner tests.
TEST_UNITY = '1'
TEST_MODES = 'EditMode PlayMode'
// Automatically create C# docs using DocFX.
BUILD_DOCUMENTATION = '0'
// Deploy the package to a Verdaccio server.
DEPLOY_TO_VERDACCIO = '0'
VERDACCIO_URL = 'http://verdaccio:4873'
VERDACCIO_STORAGE = '/var/verdaccio'
// Only attempt to deploy if the current VCS branch is among the branches listed. Note that Plastic's branches start with a slash.
DEPLOYMENT_BRANCHES = ['main', '/main']
// Report the build status to a Discord Webhook.
REPORT_TO_DISCORD = '0'
DISCORD_WEBHOOK = 'https://discord.com/api/webhooks/etc'
// Report the build status to a Microsoft Office 365 Webhook.
REPORT_TO_OFFICE_365 = '0'
OFFICE_365_WEBHOOK = 'https://webhook.office.com/etc'
}
```