Skip to content

MAINTAINING.md

Latest commit

 

History

History
38 lines (30 loc) · 2.28 KB

MAINTAINING.md

File metadata and controls

38 lines (30 loc) · 2.28 KB
Raw

Maintainer Guide

Publish a New Version

  1. Choose the new version according to the project's versioning scheme.
  2. Update the project's status in the README.md file, if required.
  3. Update the copyright statement in the LICENSE.md file, if required.
  4. Update the <Copyright> statement and <PackageLicenseExpression> field in the Directory.Build.props, if required.
  5. Update the Cesium's statement in GetCompilerBundleCopyrightStatements method of Build.Sdk.cs, if required.
  6. Update the PackageLicenseExpression and the <Copyright> statement in the Cesium.Compiler.csproj file (for the compiler dotnet tool), if required. Make sure all the packed libraries are properly accounted for.
  7. Run the scripts/Update-Version.ps1 script with the argument -NewVersion <the new version>. It will update the various places where the new version should be used.
  8. Prepare a corresponding entry in the CHANGELOG.md file (usually by renaming the "Unreleased" section).
  9. Merge the aforementioned changes via a pull request.
  10. Check if the NuGet key is still valid (see the Rotate NuGet Publishing Key section if it isn't).
  11. Push a tag in form of v<VERSION>, e.g. v0.0.0. GitHub Actions will do the rest (push a NuGet package).

Rotate NuGet Publishing Key

CI relies on a NuGet API key being added to the secrets. From time to time, this key requires maintenance: it will become obsolete and will have to be updated.

To update the key:

  1. Sign in onto nuget.org.

  2. Go to the API keys section.

  3. Update the existing or create a new key named cesium.github with a permission to Push only new package versions and allowed to publish the packages according to the regex Cesium.*.

    (If this is the first publication of a new package, upload a temporary short-living key with permission to add new packages and rotate it afterward.)

  4. Paste the generated key to the NUGET_TOKEN variable on the action secrets section of GitHub settings.