Giter Club home page Giter Club logo

unity-cicd-template's Introduction

This template repo is intended to set up a cicd workflow that runs test builds on branches and deploys to itchio from main

Initial Template Setup

Setting Up License

Before you can run the unity-builder action, you'll need to create a unity license:

  • Move activation.yml to .github/workflows
  • Push code to trigger action
  • Upload it at license.unity3d.com to receive your .ulf file
  • Add the contents to a secret named UNITY_LICENSE in Settings > Secrets
  • Remove the action from workflows

Set up Butler Credentials

Set up your Butler credentials, following the CI Builds Credentials documentation on Itch.io

Add your api key to a secret named BUTLER_CREDENTIALS in github in Settings > Secrets

Set up Builds and Deploys

Move the contents of the workflows/ directory to .github/workflows/ in the root of this repo In the release.yml file:

  • replace PROJECT_NAME with the name for your game (must be valid file path)
  • replace USER_NAME with your itchio username

Set up an Itch.io Project

Navigate to https://itch.io/game/new and make sure you use the PROJECT_NAME from above

Select HTML as the "Kind of Project"

Probably set Release status to Prototype and leave as Draft

Set up a Unity Project

I haven't found a clean way to set this up in repo root path. My workaround is to

  1. From Unity Hub on your machine and start a new project in the repo root
  2. mv the contents of that project into to root itself and rmdir the empty dir
  3. In Unity Hub remove the project from the list
  4. Add the project back to Unity Hub from it's new location at the root of the repo

Local Testing

From the Build directory, start a server: python -m http.server --cgi 8360 Then access the server via: http://localhost:8360/index.html

unity-cicd-template's People

Contributors

dstuck avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.