Skip to content

Commit 0fcef77

Browse files
passyfacebook-github-bot
authored andcommitted
Maven release docs (#1087)
Summary: *Context: The Yoga OSS build has not been given a lot of attention over the past couple of years and is in serious disrepair. I'll try to get the release pipeline going again to publish to Maven Central as JCenter is shutting down. A bunch of intermediate commits may still have broken builds but will be inching closer to a working one.* Adds some docs on how to use the release workflow. Pull Request resolved: #1087 Reviewed By: priteshrnandgaonkar Differential Revision: D28604686 Pulled By: passy fbshipit-source-id: 44cac2cd0593a4f71d80df1ec5324c3c27fbe888
1 parent e3a59aa commit 0fcef77

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,29 @@ This will now only run the standalone webpack build upon install.
4646
| node | Builds node js version. |
4747
| standalone | Runs webpack. |
4848
| none | Does nothing. You can use the prepackaged libs. |
49+
50+
## Maintainer Release Guide
51+
52+
To publish a new release, follow these steps:
53+
54+
1. Ensure you have your GPG key set up and your [OSS Sonatype](https://oss.sonatype.org/) credentials handy.
55+
2. Add the follow entries to either your local `gradle.properties` (don't forget to revert) or your global `~/.gradle/gradle.properties`:
56+
57+
```
58+
# You get these from https://oss.sonatype.org/#profile;User%20Token
59+
mavenCentralRepositoryUsername=<username>
60+
mavenCentralRepositoryPassword=<password>
61+
62+
# You can get the keyId (in GPG 1.4 format) by running `gpg1 --list-keys`.
63+
signing.secretKeyRingFile=</path/to/secring.gpg>
64+
signing.keyId=<key_id>
65+
signing.password=<key_password>
66+
```
67+
68+
3. Change the `VERSION_NAME` in `gradle.properties` to a non-SNAPSHOT release.
69+
4. Commit and land the version change.
70+
5. Run `./gradlew publishToMaven`.
71+
6. Run `./gradlew closeAndReleaseRepository`.
72+
7. Change the `VERSION_NAME` in `gradle.properties` back to a new SNAPSHOT release.
73+
8. Commit and land the version change.
74+
9. Celebrate! You've made a release!

0 commit comments

Comments
 (0)