FontainebleauDemo/LocalPackages/LightingTools.LightmapSwitcher

UPM Package Starter Kit

The purpose of this package starter kit is to provide the data structure and development guidelines for new packages meant for the Unity Package Manager (UPM).

This is the first of many steps towards an automated package publishing experience within Unity. This package starter kit is merely a fraction of the creation, edition, validation, and publishing tools that we will end up with.

We hope you enjoy your experience. You can use #devs-packman on Slack to provide feedback or ask questions regarding your package development efforts.

Are you ready to become a package?

The Package Manager is a work-in-progress for Unity and, in that sense, there are a few criteria that must be met for your package to be considered on the package list at this time:

• Your code accesses public Unity C# APIs only. If you have a native code component, it will need to ship with an official editor release. Internal API access might eventually be possible for Unity made packages, but not at this time.
• Your code doesn't require security, obfuscation, or conditional access control. Anyone should be able to download your package and access the source code.

Package structure

<root>
  ├── package.json
  ├── README.md
  ├── CHANGELOG.md
  ├── LICENSE.md
  ├── Third Party Notices.md
  ├── QAReport.md
  ├── Editor
  │   ├── Unity.[YourPackageName].Editor.asmdef
  │   └── EditorExample.cs
  ├── Runtime
  │   ├── Unity.[YourPackageName].asmdef
  │   └── RuntimeExample.cs
  ├── Tests
  │   ├── .tests.json
  │   ├── Editor
  │   │   ├── Unity.[YourPackageName].Editor.Tests.asmdef
  │   │   └── EditorExampleTest.cs
  │   └── Runtime
  │        ├── Unity.[YourPackageName].Tests.asmdef
  │        └── RuntimeExampleTest.cs
  ├── Samples
  │   └── Example
  │       ├── .sample.json
  │       └── SampleExample.cs
  └── Documentation~
       ├── your-package-name.md
       └── Images

Develop your package

Package development works best within the Unity Editor. Here's how to set that up:

1. Clone the Package Starter Kit repository locally.

   • In a console (or terminal) application, choose a place to clone the repository and enter the following:

     git clone git@github.cds.internal.unity3d.com:unity/com.unity.package-starter-kit.git
     

2. Create a new repository for your package and clone to your desktop.

   • On Github.cds create a new repository with the name of your package (Example: "com.unity.terrain-builder").

   • In a console (or terminal) application, choose a place to clone the repository and perform the following:

     git clone git@github.cds.internal.unity3d.com:unity/com.unity.[your-package-name]
     

3. Copy the contents of the Package Starter Kit folder to your new package. Be careful not to copy the Package Starter Kit .git folder over.

4. Fill in your package information.

Follow the instructions for filling out your package manifest (package.json).

Then update the "createSeparatePackage" field in the Tests/.tests.json file to set up testing for Continuous Integration (CI):

• Set it to false if you want the tests to remain part of the published package. This is the default value.

• Set it to true if you want the CI to create a separate package for these tests, and add the metadata at publish time to link the packages together. This allows you to have a large number of tests, or assets, etc. that you don't want to include in your main package, while making it easy to test your package with those tests & fixtures.

1. Start Unity, create a local empty project and import your package into the project.

2. In a console (or terminal) application, push the package starter kit files you copied in your new package repository to its remote.

   • Add them to your repository's list to version git add .
   • Commit to your new package's remote master git commit
   • Push to your new package's remote master git push

3. Restart Unity. This forces the Package Manager to rescan your project so that it can find the new package that you just embedded. For more information on embedded packages see Confluence.

4. Update the README.md file.

   It should contain all pertinent information for developers using your package, such as:

   • Prerequistes
   • External tools or development libraries
   • Required installed Software
   • Command line examples to build, test, and run your package.

5. Rename and update your documentation file(s).

   Use the samples included in this starter kit to create preliminary, high-level documentation. Your documentation should introduce users to the features and sample files included in your package. For more information, see Document your package.

6. Rename and update assembly definition files.

   Choose a name schema to ensure that the name of the assembly built from the assembly definition file (.asmdef) will follow the .Net Framework Design Guidelines. For more information, see Name your assembly definition files.

7. Add samples to your package (code & assets).

   The Package Manager recognizes the Samples directory in a package but does not import samples into Unity when the package is added to a project by default. Users can import samples into their /Assets directory by clicking the Import in project button from the Details view of your package in the Package Manager window.

   If your package contains a sample:

   • Rename the Samples/Example folder, and update the .sample.json file in it.

   • If your package contains multiple samples, make a copy of the Samples/Example folder for each sample, and update each .sample.json file accordingly.

   Delete the Samples folder altogether if your package does not need samples.

8. Validate your package using the Validation Suite.

   Before you publish your package, you need to make sure that it passes all the necessary validation checks by using the Package Validation Suite extension. This is required.

   For more information, see Validate your package.

9. Follow our design guidelines

   Follow these design guidelines when creating your package:

   • The package design standards on Confluence.

   • The design checklist from Unity's Human Interface Guidelines.

   • The namespace for code in the asmdef must match the asmdef name, except the initial Unity, which should be replaced with UnityEngine or UnityEditor.

   • For Runtime code, only use the Unity namespace for code that has no dependency on anything in UnityEngine or UnityEditor and instead uses ECS and other Unity-namespace systems.

10. Add tests to your package.

    For Editor tests:

    • Write all your Editor Tests in Tests/Editor
    • If your tests require access to internal methods, add an AssemblyInfo.cs file to your Editor code and use [assembly: InternalsVisibleTo("Unity.[YourPackageName].Editor.Tests")].

    For Playmode Tests:

    • Write all your Playmode Tests in Tests/Runtime.
    • If your tests require access to internal methods, add an AssemblyInfo.cs file to your Runtime code and use [assembly: InternalsVisibleTo("Unity.[YourPackageName].Tests")].

11. Setup your package CI.

    Make sure your package continues to work against trunk or any other branch by setting up automated testing on every commit. See the Confluence page that explains how to set up your package CI.

    This starter kit contains the minimum recommended workflow for package CI, which provides the barebones to: pack, test and publish your packages. It also contains the required configuration to promote your preview packages to production.

12. Update CHANGELOG.md.

    Every new feature or bug fix should have a trace in this file. For more details on the chosen changelog format, see Keep a Changelog.

Fill out your package manifest

1. Update the following required fields in file package.json (see Confluence for more information):

   Attribute name	Description
   "name"	Set the package name, following this naming convention: "com.unity.[your-package-name]", without capital letters. For example, "com.unity.2d.animation".
   "displayName"	Set the package's user-friendly display name. For example, "Terrain Builder SDK". Note: Use a display name that will help users understand what your package is intended for.
   "version"	Set the package version in "X.Y.Z" format, following these Semantic Versioning guidelines: - To introduce a breaking API change, increment the major version (X.Y.Z). - To introduce a new feature, increment the minor version (X.Y.Z). - To introduce a bug fix, increment the patch version (X.Y.Z)
   "unity"	Set the Unity version your package is compatible with. For example: "2018.1".
   "unityRelease"	Specify the Unity patch release your package is compatible with. For example: "0a8". Note: This field is only required when the specific Unity version has a patch release.
   "description"	This description appears in the Package Manager window when the user selects this package from the list. For best results, use this text to summarize what the package does and how it can benefit the user. Special formatting characters are supported, including line breaks (\n) and unicode characters such as bullets (\u25AA). For more information, see the Writing Package docs page on Confluence.

2. Update the following recommended fields in file package.json:

   Attribute name	Description
   "dependencies"	List of packages this package depends on. All dependencies will also be downloaded and loaded in a project with your package. Here's an example: dependencies: {     "com.unity.ads": "1.0.0",     "com.unity.analytics": "2.0.0" }
   "keywords"	An array of keywords related to the package. This field is currently purely informational.
   "type"	The type of your package. This is used to determine the visibility of your package in the Project Browser and the visibility of its Assets in the Object Picker. The "tool" and "library" types are used to set your package and its Assets as hidden by default. If not present or set to another value, your package and its Assets are visible by default.
   "hideInEditor"	A boolean value that overrides the package visibility set by the package type. If set to false, the default value, your package and its Assets are always visible by default; if set to true, your package and its Assets are always hidden by default.

   Notes:

   • For packages in development, neither "type" nor "hideInEditor" are used. The package is always visible in the Project Browser and its Assets are always visible in the Object Picker.
   • The user is always able to toggle the package visibility in the Project Browser, as well as their Assets visibility in the Object Picker.

Document your package

You need to document your public APIs and provide task-oriented documentation for your features:

1. Document all of your public APIs and your features.
2. Test your documentation locally.
3. Get your documentation published.

Your package should include the documentation source in your package, but not the generated HTML.

The page in the user manual that links to package documentation is Packages documentation.

Document your public APIs

API documentation is generated from any XmlDoc tagged comments found in the .cs files included in the package.

You can use Visual Studio to autogenerate the correct tags by entering the documentation comments (///) in the empty line above your code. Visual Studio automatically detects which tags your code needs and inserts them. For example, if you write a method with two parameters that returns a value, Visual Studio gives you the summary tag (for the method description), two param tags, and one returns tag:

/// <summary>
///
/// </summary>
/// <param name="One"></param>
/// <param name="Two"></param>
/// <returns></returns>
public bool TestingXmlDoc(int One, int Two)
{

}

See the Editor/EditorExample.cs file in this package for examples of how to document classes, methods, properties, and enums.

You need to document all public APIs. If you don't need an API to be accessed by clients, mark it as internal instead:

1. Add a custom filter.yml file to the package Documentation~ folder.

2. Add these rules to your custom filter.yml file. These rules make the DocFX configuration consistent with packages that don't have a custom filter:

   apiRules:
     - exclude:
       # inherited Object methods
       uidRegex: ^System\.Object\..*$
       type: Method
     - exclude:
       # mentioning types from System.* namespace
       uidRegex: ^System\..*$
       type: Type
     - exclude:
       hasAttribute:
         uid: System.ObsoleteAttribute
       type: Member
     - exclude:
       hasAttribute:
         uid: System.ObsoleteAttribute
       type: Type
   

   ``

3. Specify classes to exclude by UID or by specifying regular expressions. For information about the rules for the filters, see the DocFX guide.

Document your features

Write the Manual documentation using GitHub-flavored Markdown in .md files stored under the Documentation~ folder. The Documentation~ folder is suffixed with ~ to prevent its contents from being loaded in the Editor (recommended). Alternatively, you could use .Documentation for the folder name.

This preliminary, high-level documentation should introduce users to the features and sample files included in your package.

All packages that expose UI in editor or runtime features should use one of the appropriate documentation example guides under the Documentation~ folder:

• tools-package-guide.md for a package that includes features that augment the Unity Editor or Runtime (modules, tools, and libraries)
• sample-package-guide.md for a package that includes sample files
• test-package-guide.md for a package that provides tests

For instructions, see the documentation guidelines.

Test your documentation locally

As you are developing your documentation, you can see what your documentation will look like by using the DocTools package: com.unity.package-manager-doctools (optional).

Once the DocTools package is installed, it displays a Generate Documentation button in the Package Manager window's Details view for any installed or embedded packages. To install the extension, see Installing the DocTools package on Confluence.

The DocTools extension is still in preview, if you come across arguable results, please discuss them on #docs-packman.

Get your documentation published

When the documentation is complete, notify the technical writer assigned to your team or project. If you don't know which technical writer is assigned, fill out the Package Docs Questions form, log a JIRA DOC ticket and attach the form to that ticket.

You can also ask for help or clarification on #devs-documentation.

Note: The package will remain in preview mode until the final documentation is completed. Users will have access to the developer-generated documentation only in preview packages.

After the technical writer reviews the documentation, they will create a pull request in the package git repository. The package's development team will then need to submit a new package version with the updated docs.

Name your assembly definition files

If your package contains Editor code, rename and modify Editor/Unity.YourPackageName.Editor.asmdef. Otherwise, delete the Editor directory.

• Name must match your package name, suffixed by .Editor (for example, Unity.[YourPackageName].Editor).
• Assembly must reference Unity.[YourPackageName] (if you have any runtime code).
• Platforms must include "Editor".

If your package contains code that needs to be included in Unity runtime builds, rename and modify Runtime/Unity.YourPackageName.asmdef. Otherwise, delete the Runtime directory.

• Name must match your package name (for example,Unity.[YourPackageName])

If your package has Editor code, you must have Editor Tests. In that case, rename and modify Tests/Editor/Unity.YourPackageName.Editor.Tests.asmdef.

• Name must match your package name, suffixed by .Editor.Tests (for example, Unity.[YourPackageName].Editor.Tests)
• Assembly must reference Unity.[YourPackageName].Editor and Unity.[YourPackageName] (if you have any Runtime code).
• Platforms must include "Editor".
• Optional Unity references must include "TestAssemblies" to allow your Editor Tests to show up in the Test Runner or run on Katana when your package is listed in the project manifest's testables field.

If your package has Runtime code, you must have Playmode Tests. In that case, rename and modify Tests/Runtime/Unity.YourPackageName.Tests.asmdef.

• Name must match your package name, suffixed by .Tests (for example, Unity.[YourPackageName].Tests)
• Assembly must reference Unity.[YourPackageName].
• Optional Unity references must include "TestAssemblies" to allow your Playmode Tests to show up in the Test Runner or run on Katana when your package is listed in the project manifest's testables field.

Validate your package

To install the extension, follow these steps:

1. Make sure you have Package Manager UI v1.9.6 or above.

2. Make sure your project manifest points to the Candidates registry, which you can do by changing the registry line to:

   "registry": "https://artifactory.prd.cds.internal.unity3d.com/artifactory/api/npm/upm-candidates"
   

   ``

3. From the Package Manager window, install the latest version of the Package Validation Suite with the scope set to All Packages. If you don't see it in the list, make sure Advanced > Show preview packages is enabled.

Once the Validation Suite package is installed, a Validate button appears in the details pane when you select your installed package from the Package Manager window.

To run the tests:

1. Click the Validate button to run a series of tests. A See Results button appears after the test run.
2. Click the See Results button for additional explanation:
   • If it succeeds, a green bar displays a Success message.
   • If it fails, a red bar displays a Failed message.

The validation suite is still in preview, so if you come across arguable results, please discuss them on #devs-packman.

Create a Pre-Release Package

Pre-Release Packages are a great way of getting your features in front of Unity Developers in order to get early feedback on functionality and UI designs. Pre-Release packages need to go through the publishing to production flow, as would any other package, but with diminished requirements:

• Expected Package structure respected
• Package loads in Unity Editor without errors
• License file present - With third party notices file if necessary
• Test coverage is good - Optional but preferred
• Public APIs documented, minimal feature docs exists- Optional but preferred

The only supported Pre-Release tag is preview which you suffix to the version number of the package in the package.json manifest file. For example:

"version" : "1.2.0-preview"

Register your package

If you think you are working on a feature that is a good package candidate, please take a minute to tell Release Management about it in the #devs-pkg-promotion channel.

Working with the board of dev directors and with product management, we will schedule the entry of the candidates in the ecosystem, based on technical challenges and on our feature roadmap. Don’t hesitate to reach out and join us on #devs-packman on Slack.

Share your package

If you want to share your project with other developers, the steps are similar to what's presented above. On the other developer's machine:

1. Start Unity and create a local empty project.

2. Launch the console (or terminal) application, navigate to the newly created project folder, and then clone your repository in the Packages directory:

   cd <YourProjectPath>/Packages
   git clone https://github.cdsinternal.unity3d.com/unity/[your-package-name].git com.unity.[sub-group].[your-package-name]
   

   Note: Your directory name must be the name of your package (Example: "com.unity.terrain-builder").

Make sure your package meets all legal requirements

All packages must COMPLETE AND SUBMIT THIS FORM to receive approval. It is a simple, streamlined form that tells legal if there are any potential issues that need to be addressed prior to publication.

If your package has third-party elements and its licenses are approved, then all the licenses must be added to the Third Party Notices.md file. If you have more than one license, duplicate the Component Name/License Type/Provide License Details section for each additional license.

Note: A URL can work as long as it actually points to the reproduced license and the copyright information (if applicable).

If your package does not have third party elements, you can remove the Third Party Notices.md file from your package.

Preparing your package for the Candidates registry

Before publishing your package to production, you must send your package on the Package Manager's internal candidates repository. The candidates repository is monitored by QA and release management, and is where package validation will take place before it is accepted in production.

1. Publishing your changes to the Package Manager's Candidates registry happens from Github.cds. To do so, set up your project's Continuous integration (CI), which will be triggered by "Tags" on your branches.

   For information see the Confluence page that describes how to set up CI for your package.

2. Test your package locally. Once your package is published on the Candidates registry, you can test your package in the editor by creating a new project, and editing the project's manifest.json file to point to your candidate package:

   dependencies: {
     "com.unity.[sub-group].[your-package-name]": "0.1.0"
   },
   "registry": "https://artifactory.prd.cds.internal.unity3d.com/artifactory/api/npm/upm-candidates"
   

Get your package published to Production

Packages are promoted to the Production registry from the Candidates registry, as described above. Your package must meet certain criteria before you can submit a request to promote a package to production.

Once you feel comfortable that your package meets the list of Release Management Criteria, ask to be promoted from candidates to production by going to #devs-pkg-promotion.

Also, once you have a package in production for a few versions and it was used by real users, you can ask to be whitelisted to appear in the Package Manager window. Your package will not be visible in the Package Manager window until it is published AND whitelisted by Release Management.

Release management will validate your package content, and check that the editor/playmode tests pass before promoting the package to production.

Verified status and bundled packages

If your package is meant to ship with a release of the editor (Verified Packages and Bundled Packages), follow these steps:

1. To be marked as verified, in trunk, modify the editor manifest ([root]\External\PackageManager\Editor\manifest.json) to include your package in the verified list.

2. If your package is not verified, but only bundled with the editor, submit one or more Test Project(s) in Ono, so that your new package can be tested in all ABVs moving forward.

   The following steps will create a test project that will run in ABVs, load your package into the project, and run all the tests found in your package. The better your test coverage, the more confident you'll be that your package works with trunk.

   • Create a branch in Ono, based on the latest branch this package must be compatible with (trunk, or release branch).
   • If your package contains Editor Tests:

     • In [root]\Tests\Editor.Tests, create a new EditorTest Project (for new packages use YourPackageName) or use an existing project (for new versions of existing package).

       To get a bare package for an EditorTest Project, click here.

     • Modify the project’s manifest.json file to include the production version of the package (name@version).

     • Your project's manifest.json file should contain the following line:

       "testables" : [ "com.unity.[sub-group].[your-package-name]" ]
       

   • If your package contains PlaymodeTests:

     • In [root]\Tests\PlaymodeTests, create a new PlaymodeTest Project (for new packages use YourPackageName) or use an existing project (for new versions of existing package).

     • Modify the project’s manifest.json file to include the candidate version of the package (name@version).

     • Your project's manifest.json file should contain the following line:

       "testables" : [ "com.unity.[sub-group].[your-package-name]" ]
       

     • Commit your branch changes to Ono, and run all Windows & Mac Editor/PlayMode tests (not full ABV) in Katana.

3. Once the tests are green on Katana, create your PR, add both Latest Release Manager and Trunk Merge Queue as reviewers.

FAQ

What’s the difference between a preview package and a verified package?

A preview package is a great way to develop and get feedback on new features and functionality. Preview package can be created against any version of Unity 2018.1+, and can be made discoverable through the Package Manager UI by issuing a request in #devs-packman. Quality and release schedule is up to the package owner, although minimum bars are set in place to ensure the package contains the right licenses, documentation, and a comprehensive set of tests.

Once a preview package has been in the field for 2-3 release cycles of the editor, that package can be considered for Verification. Verified packages are tested with a specific version of the editor, and offer our users a compatibility guarantee. Verified packages are the only packages that can be included in the set of templates we ship with the editor (Verified Templates). Code for these packages must follow core development guidelines, including code cutoff dates, and are tested in katana for continued compatibility.

What’s the difference between a core package and a default package?

A core package is a package that has its code included with the Editor’s core code. This is interesting for packages that plan to change enormously in parallel to editor APIs. By moving package code to the editor’s repo, both core API\functionality changes can be made along with required packages changes in the same PR. https://docs.google.com/document/d/1CMoanjR3KAdew-6n39JdCFmHkTp1oshs3vkpejapf4Q/edit

A default package is a verified package that gets installed with every new project users create, regardless of the template they use. We should limit the number of default packages we support, as each default package adds to the project loading time. The list of default packages can be found in the editor manifest (de904b9e/External/PackageManager/Editor/manifest.json).

What are the requirement for me to publish a preview package?

https://docs.google.com/document/d/1epGkAJRayJLN89_weA_-G5LFT_1uFifFZqBzAgvp_Zs/

What are the requirements for me to get my package verified for a version of unity?

https://docs.google.com/document/d/1oWC9XArVfkGMnqN9azR4hW4Pcd7-kQQw8Oy7ckP43JE/

How is my verified package tested in Katana?

https://docs.google.com/document/d/1jwTh71ZGtB2vF0SsHEwivt2FunaJWMGDdQJTpYRj3EE/edit

How is my template tested in Katana?

https://docs.google.com/document/d/1jwTh71ZGtB2vF0SsHEwivt2FunaJWMGDdQJTpYRj3EE/edit

How do I add samples to my package?

https://docs.google.com/document/d/1rmxGh6Z9gtbQlGUKCsVBaR0RyHvzq_gsWoYs6sttzYA/edit#heading=h.fg1e3sz56048

How do I setup CI or publishing options for my package? https://confluence.hq.unity3d.com/display/PAK/Setting+up+your+package+CI

How can I add tests to my package?

There’s a “Tests” directory in the package starter kit. If you add editor and playmode tests in that directory, they will make up the list of tests for your package.

The tests in my package bloat my package too much, what are my options?

https://docs.google.com/document/d/19kKIGFetde5ES-gKXQp_P7bxQ9UgBnBUu58-y7c1rTA/edit

Can I automate my package publishing yet?

Not just yet, but we’re working on it. The first automated publishing we will enable is the push to production for preview packages. Basically, when your package passes validation (loads in the editor without error, the tests in the package pass, validation suite run success), the package will be pushed to production automatically. Other publishing flows will soon be available as well, here’s the full list of internal package publishing flows Unity will support. https://docs.google.com/document/d/1zdMzAtfi-vgM8NMPmwL40yinBeL3YImwTO5gSfGNCgs/edit

How do I get a template package started?

Start with the Project Template Starter Kit (you can request access in #devs-packman). https://github.cds.internal.unity3d.com/unity/com.unity.template-starter-kit

How do I get my package included in a template?

First and foremost, your package needs to be on the verified list of packages. Only verified packages can get added to templates we ship with the editor. Then reach out to the templates community in #devs-template to open discussions on adding your package to one or more of our existing templates.

How can I test my package locally, as a user would?

https://confluence.hq.unity3d.com/display/PAK/How+to+add+a+git+package+to+your+project

What tests are included by the validation suite?

https://docs.google.com/spreadsheets/d/1CdO7D0WSirbZhjnVsdJxJwOPK4UdUDxSRBIqwyjm70w/edit#gid=0