Skip to content

Commit a73221f

Browse files
authored
Merge pull request #39 from contentpass/docs-update-docs-about-publishing-with-workflows
docs: update docs about publishing with workflows
2 parents 1b83ad6 + d8a07c6 commit a73221f

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,14 +144,25 @@ Our pre-commit hooks verify that the linter and tests pass when committing.
144144

145145
### Publishing to npm
146146

147-
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.
147+
We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common
148+
tasks like bumping version based on semver, creating tags and releases etc.
148149

149150
To publish new versions, run the following:
150151

151152
```sh
152153
yarn release
153154
```
154155

156+
#### Publishing the Package to npm using GitHub Actions
157+
You can use GitHub Actions to automate the process of publishing the package to npm. Follow these steps:
158+
1. Navigate to [release workflow](https://github.com/contentpass/react-native-contentpass/actions/workflows/release.yml) on GitHub.
159+
2. Run the workflow manually:
160+
- Click on the `Run workflow` button.
161+
- Select the `main` branch.
162+
- Confirm and execute the workflow.
163+
164+
This process will handle the publication of the package to npm using the configurations defined in the workflow.
165+
155166
### Sending a pull request
156167

157168
> **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).

0 commit comments

Comments
 (0)