Skip to content

MAINTAINING.md

Latest commit

 

History

History
41 lines (32 loc) · 2.15 KB

MAINTAINING.md

File metadata and controls

41 lines (32 loc) · 2.15 KB

Maintainer Guide

Publish a New Version

  1. Update the project's status in the README.md file, if required.
  2. Update the copyright statement in the LICENSE.txt file, if required.
  3. Update the copyright statement in the Directory.Build.props file, if required.
  4. Prepare a corresponding entry in the CHANGELOG.md file (usually by renaming the "Unreleased" section).
  5. Set <Version> in the Directory.Build.props file.
  6. Merge the aforementioned changes via a pull request.
  7. Check if the NuGet keys are still valid (see the Rotate NuGet Publishing Keys section if they aren't).
  8. Push a tag in form of v<VERSION>, e.g. v0.0.0. GitHub Actions will do the rest (push a NuGet packages).

Rotate NuGet Publishing Keys

CI relies on NuGet API keys being added to the secrets. From time to time, these keys require maintenance: they 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 truepath.github with a permission to Push only new package versions and only allowed to publish the package TruePath.

    (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. Update the existing or create a new key named truepath.systemio.github with a permission to Push only new package versions and only allowed to publish the package TruePath.SystemIo.

    (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.)

  5. Paste the generated keys, correspondingly, to the NUGET_TOKEN_TRUE_PATH and NUGET_TOKEN_TRUE_PATH_SYSTEM_IO variables on the action secrets section of GitHub settings.