From 63648664c55fc5e5e1ee6545dd66cd759f14127f Mon Sep 17 00:00:00 2001 From: Jan Loewe <jan.loewe@ptb.de> Date: Thu, 29 Jun 2023 09:32:56 +0200 Subject: [PATCH] fix(readme): adjust publishing instructions --- README.md | 17 +++-------------- 1 file changed, 3 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 3bfbd82..cbd8ef3 100644 --- a/README.md +++ b/README.md @@ -77,21 +77,10 @@ express or implied. See [the Licence](LICENSE.md) for the specific language governing permissions and limitations under the Licence. -## Publishing this package - -Add the following to your `.yarnrc.yml` in your **home folder**. Do not commit your token! - -```yml -npmRegistries: - https://gitlab1.ptb.de/api/v4/projects/105/packages/npm/: - npmAlwaysAuth: true - npmAuthToken: "<token>" -``` - - -### Publishing workflow +## Publishing the package 1. Commit all changes 2. Bump the version with `yarn version [major | minor | patch | ...]` 3. Push all commits to the remote -4. Publish the package with `yarn npm publish` +4. Create a tag with the following name: `v<version>` (e.g. `v1.0.0`) +5. Push the tag to the remote, the CI will create a release and publish the package -- GitLab