Skip to content

Package settings

Jump to bottom
Miguel Nicolás-Díaz edited this page Oct 18, 2023 · 5 revisions

The package settings window can be accessed by opening the Deploy editor window Tools -> Facticus -> Deploy -> Open Deploy editor window and then clicking on the Package settings tab.

  • Workflow Id: The file's name (without extension) of the workflow used to build and deploy your project with Github Actions. This file should be in the <Git Directory>/.github/workflows/ directory. You don't have worry about setting this field's value or creating the file if you generate it with the Generate workflow button.
  • Update Workflow Automatically: Recommended value: true. Whether to update the GitHub Actions workflow with the last version. If true, it will modify the file <Git Directory>/.github/workflows/<Workflow Id>.yml every time you update Deploy through package manager. Remember to commit and push this change before clicking 'Build and Deploy', otherwise it will not take effect.
  • Git Directory: It should point to your git repository's root directory relative to your Unity project's root. Commonly, both directories match, in which case you should leave the field empty. ⚠️ This feature is not fully supported yet, if you find yourself in a case where both directories (unity project root and git root) don't match, please create an issue giving details.
  • Default Asset Directory: The directory (within the Assets folder) where Deploy assets, such as the settings and deploy contexts, will be created.
  • Backend: The backend tool/platform/service used to run the builds. Options are:
    • Github Actions: The recommended and fully supported backend tu use.
    • Act: Not fully supported as it has some issues. Only recommended if you want to reduce billing usage of Github Actions service, or for some reason cannot use it. Act is a tool to run Github Actions' workflows locally by "replicating" its ecosystem in your computer. You need to install it first according to its instructions.
  • Notify Platform: The platform used to notify the success or failure of your builds. Currently, only supported Telegram. Set to null if you don't want to receive notifications.
  • Versioning Strategy: The schema used to determine your project's version.
    • Semantic: Generates a version based on semantic versioning. Follows .. for example 0.17.2. The latest tag dictates . (defaults to 0.0 for no tag). The number of commits (since the last tag, if any) is used for . To increment major or minor version, manually add a tag to a commit that follows the . versioning convention. Optionally, the version number can have a v prefix, for example v0.17.
    • Tag: Generates the version based on the git tag of the latest commit (HEAD). For example 0.17.2 will generate the version 0.17.2. A leading "v" is stripped, so a version of v1.3.3 will generate a version of 1.3.3. (advanced users)
    • None: Do not generate a version for your project. Your project will be built with the version set in Player settings.

Clone this wiki locally