UnityCodeCommenter

He can make comments on your code style in Unity game engine projects

About The Project

• This project makes use of resharper_inspectcode action convenient to use for Unity repos that require solution files generation.
• For each pull request this workflow will generate a solution file for your Unity project, run reSharper Inspect code and provide it's output as PR comments.
• Everything runs on GitHub runner (for free).

Demo

1. Fork this repository
2. Modify or add new .cs file
3. Create a PR (to your new repo)
4. Watch workflow run and comment your code style in PR's "Files" section

Getting Started

1. Put check_code_style.yaml to your repo .github/workflows
2. Open check_code_style.yaml and modify PROJECT_NAME
   (It's the name of a directory of your Unity project)
3. Modify PROJECT_PATH
   (If your Assets directory is in the repo's root - put "." as project path.)
4. Set up GitHub secrets UNITY_EMAIL, UNITY_PASSWORD, UNITY_SERIAL
5. Code style rules should be defined in {project_name}.DotSettings file in Unity project directory
6. The inspection step could be set up according to the documentation

Prerequisites

Unity Pro+ license.
Unity Personal license activation details are here.

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Kirill Kostenkov - contacts

Acknowledgments

• Best Readme template
• ReSharper CLI InspectCode GitHub action
• GameCI Unity builder

(back to top)