From d8a07c696c9e7bf99858d7ed935d184c3fffc984 Mon Sep 17 00:00:00 2001 From: slawek Date: Thu, 12 Dec 2024 12:44:52 +0100 Subject: [PATCH] docs: update docs about publishing with workflows --- docs/CONTRIBUTING.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 5e77dc6..cc391ed 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -144,7 +144,8 @@ Our pre-commit hooks verify that the linter and tests pass when committing. ### Publishing to npm -We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc. +We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common +tasks like bumping version based on semver, creating tags and releases etc. To publish new versions, run the following: @@ -152,6 +153,16 @@ To publish new versions, run the following: yarn release ``` +#### Publishing the Package to npm using GitHub Actions +You can use GitHub Actions to automate the process of publishing the package to npm. Follow these steps: +1. Navigate to [release workflow](https://github.com/contentpass/react-native-contentpass/actions/workflows/release.yml) on GitHub. +2. Run the workflow manually: + - Click on the `Run workflow` button. + - Select the `main` branch. + - Confirm and execute the workflow. + +This process will handle the publication of the package to npm using the configurations defined in the workflow. + ### Sending a pull request > **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).