-
-
Notifications
You must be signed in to change notification settings - Fork 853
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
37 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,28 @@ | ||
# How to create a release for this repo | ||
|
||
## Make sure `master` builds correctly | ||
|
||
Are all our [actions](https://github.com/react-native-mapbox-gl/maps/actions) passing successfully? | ||
If not, make sure to investigate the issue and fix it prior to a release. | ||
|
||
## Bump the version in our package.json | ||
|
||
Once you verified, that `master` isn't broken, go on and increase the `version` within our `package.json`. | ||
|
||
## Update the CHANGELOG accordingly | ||
|
||
Our [`CHANGELOG.md`](https://github.com/react-native-mapbox-gl/maps/blob/master/CHANGELOG.md) should be updated whenever a PR is merged/ noteworthy changes are commited to `master`. | ||
Prior to a release the changes should be documented under the `NEXT` section. | ||
Once it's clear, that a release is about to be published, move the items under `NEXT` to _this_ releases sections. | ||
Prior to a release, the changes should be documented under the `UNRELEASED` section. | ||
Once it's clear, that a release is about to be published, move the items under `UNRELEASED` to _this_ releases sections. | ||
Let your actions be guided by the previous release entries. | ||
|
||
## Draft a new release on Github | ||
Within the [releases](https://github.com/react-native-mapbox-gl/maps/releases) section of the repo you can [`Draft a new release`](https://github.com/react-native-mapbox-gl/maps/releases/new). | ||
|
||
Within the [releases](https://github.com/react-native-mapbox-gl/maps/releases) section of the repo you can [`Draft a new release`](https://github.com/react-native-mapbox-gl/maps/releases/new). | ||
|
||
`Tag version` & `Release title` should be the same. | ||
As redundant as it might sound, please add the changes from the `CHANGELOG.md` into the body of the release. | ||
|
||
## Monitor the repos issues for updates | ||
Once the release is out the door (on [npm](https://www.npmjs.com/package/@react-native-mapbox-gl/maps)), make sure to monitor the [issues](https://github.com/react-native-mapbox-gl/maps/issues) closely for problems the community might encounter | ||
|
||
Once the release is out the door (on [npm](https://www.npmjs.com/package/@react-native-mapbox-gl/maps)), make sure to monitor the [issues](https://github.com/react-native-mapbox-gl/maps/issues) closely for problems the community might encounter |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters