Skip to content

Commit d74bebe

Browse files
committed
chore: add PUBLISHING.md
1 parent 87b942c commit d74bebe

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

gradle-plugins/react/PUBLISHING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Publishing a Signed Plugin
2+
3+
To publish a signed plugin (currently to `mavenLocal` only), you need to configure the signing key data in plugin's `gradle.properties` file
4+
5+
### 1. Add Signing Key Data
6+
Update `gradle.properties` file with the following properties:
7+
```
8+
signing.keyId=<key>
9+
signing.password=<password>
10+
signing.secretKeyRingFile=<path-to-gpg-file>
11+
```
12+
* `keyId`: The public key ID.
13+
* `password`: The passphrase used when creating the key.
14+
* `secretKeyRingFile`: The absolute path to the private key file.
15+
16+
### 2. Publish the Plugin
17+
Once the signing key is set up correctly, run the following command:
18+
```sh
19+
yarn brownfield:plugin:publish:local
20+
```
21+
22+
### 3. Output
23+
If everything is configured properly, the signed plugin will be published to the `~/.m2` repository.

0 commit comments

Comments
 (0)