Repository navigation
v0.0.1
·
0 commits
to bdb4ff8e3b67c575aeb48bc9561f2956ea41f753
since this release
This is the first release of the project example.
Added
- initial project folder structure, README, CHANGELOG, CONTRIBUTING, LICENSE.
- ci: adds
buildworkflow that does the following:- compiles C# code within
./package/Editorand./package/Runtimefolders, using unity-ci and thedotnetcli. - publishes the runtime code as a NuGet package to GitHub Packages, so package runtime DLLs can be referenced in other Unity package projects. A prerelease version is automatically generated using Nerdbank.GitVersioning
- generates api documentation from the compiled C# libraries using dotnet2md. documentation files are automatically committed back to the pull request.
- compiles C# code within
- ci: adds
labelerworkflow that labels pull requests based on the changes they contain so reviewers can quickly assess new changes. - ci: adds
releaseworkflow that creates new releases when a pull request is merged to thestablebranch. See our getting started doc for more information. - ci: adds
release-upm-manualworkflow that handles creating specific git tags for publishing releases to OpenUPM - ci: adds
catsworkflow that posts cute cat gifs to your pull requests because everything is made better by cats. 🐈⬛ - ci: adds
deploy-docsworkflow that publishes the documentation within./docsto GitHub Pages using mkdocs-material - adds a
./packagefolder to hold all the code that should be released with the Unity package. - adds a
./unity-projectfolder to hold a development Unity project that is used to build and test the Unity package. - ci: versioning is handled by Nerdbank.GitVersioning via the root
./version.jsonfile. - docs: includes a basic docs folder at the root.
- docs: includes a basic PULL_REQUEST_TEMPLATE
- docs: adds some placeholder documentation files for each of the project features
- docs: adds documentation for how to publish an OpenUPM package using the project
- docs: updates the mkdocs configuration with sections for features, how to and reference documentation
- editor: adds a custom inspector for the
Examplemonobehaviour
Fixed
- docs: the main README.md uses the correct path to the
./package/LICENSE.mdfile - ci: the
buildworkflow only runs when related files change. - ci: labeler configuration is updated to apply the
runtimelabel to changes within./package/Runtime/**.