From beb368f82ae99bbeff1b937a293543fbd49d5e1d Mon Sep 17 00:00:00 2001 From: Friedrich von Never Date: Thu, 30 May 2024 01:14:12 +0200 Subject: [PATCH] Docs: update the maintainer instructions --- MAINTAINERSHIP.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/MAINTAINERSHIP.md b/MAINTAINERSHIP.md index 92164c2d..b125181c 100644 --- a/MAINTAINERSHIP.md +++ b/MAINTAINERSHIP.md @@ -9,20 +9,21 @@ Publish a New Version 3. Prepare a corresponding entry in [the changelog][changelog] (usually by renaming the "Unreleased" section). 4. Set the `` in the `Directory.Build.props`. 5. Merge all the changes to the main branch using a pull request. -6. Push a tag in form of `v`, e.g. `v0.0.1`. GitHub Actions will do the rest (push the NuGet packages). -7. If the release is not synchronized with a corresponding release of [tdlib.native][], then it's recommended to [unlist][docs.unlist] it until the corresponding release of tdlib.native is available. This will help the users to do a coordinated update and not update only a part of the libraries. +6. Make sure the NuGet keys you use for publishing are still active. If not, then rotate the keys as explained in the corresponding section of this document. +7. Push a tag in form of `v`, e.g. `v0.0.1`. GitHub Actions will do the rest (push the NuGet packages). +8. If the release is not synchronized with a corresponding release of [tdlib.native][], then it's recommended to [unlist][docs.unlist] it until the corresponding release of tdlib.native is available. This will help the users to do a coordinated update and not update only a part of the libraries. Rotate Keys ----------- -CI relies on 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. +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: +To update the keys: 1. Sign in onto nuget.org. 2. Go to the [API keys][nuget.api-keys] section. -3. Create a new key with permission to **Push new packages and package versions** and only allowed to publish **TDLib** package. -4. Create a new key with same permission and only allowed to publish **TDLib.Api** package. +3. Create a new key with permission to **Push only new package versions** and only allowed to publish **TDLib** package. Name it `github-actions.tdlib`. +4. Create a new key with same permission and only allowed to publish **TDLib.Api** package. Name it `github-actions.tdlib.api`. 5. Paste the generated API keys to the [action secrets][github.secrets] section on GitHub settings (update the `NUGET_KEY_TDLIB` and `NUGET_KEY_TDLIB_API` secrets). Update Telegram API