Skip to content

docs: update docs about publishing with workflows #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slawomirzaba merged 1 commit into from
Dec 12, 2024
Merged

docs: update docs about publishing with workflows #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,14 +144,25 @@ 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:

```sh
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).
Expand Down
Loading