Unity Package Template

This is a template repo for creating custom Unity Pacakge (upm) with github actions implemented to support auto update of packages in the npm package registery.

Features

- A Base unity Package template to work.
- Github actions implemented to support easy distribution of packages and their updates
- Auto C# documentation using DocFX


Usage

After cloning the repo :
- replace com.org-name.package-name with your org name in all file/dir names and their contents
- replace com.org-name.package-name with your package name in all files/dir names and their contents

To use packages in unity from npm registery :

Set this up

!image

- now go to window > package manger : 🎉enjoy your packages with automated changelogs and semver , don't forget to follow conventional commits

Also Use Conventional Commits for auto changelog and semver https://www.conventionalcommits.org/en/v1.0.0/

github action is taken from google-github-actions/release-please-action

Environment Variables

To run this project, you will need to add the NPM_TOKEN github secrets set up for your own repositories to make the github actions work.
To get the token follow the steps below
- https://www.npmjs.com/ create your npm account
- https://www.npmjs.com/settings/your_username/tokens get the classic token and chose automation token , it is required in the github actions for publishing without 2FA

🔗 Links

Build with ❤ By : @Eyerunnman