Skip to content

Commit 7ff5e25

Browse files
authored
Create DEPLOY.md
1 parent 79df198 commit 7ff5e25

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

DEPLOY.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Permify Java Deployment
2+
3+
## Deployment Process
4+
5+
The release process is partially automated via GitHub Actions. Here’s how it works:
6+
7+
1. **Triggering the Generator Workflow**
8+
- After a release is created in the main branch of main Permify repository, the generator workflow will be triggered automatically.
9+
- If it does not trigger automatically, it can be run manually using **Workflow Dispatch**.
10+
11+
2. **Pull Request Creation & Merge**
12+
- The generator workflow will create a pull request and merge it back into the repository.
13+
14+
3. **Dependency Check & Build**
15+
- Ensure that the dependency versions in `build.gradle` match those in `pom.xml`.
16+
- Run a clean build:
17+
```bash
18+
./gradlew clean build
19+
```
20+
21+
4. **Deployment**
22+
- Deployment to Maven Central (Sonatype) is **not yet configured** in GitHub Actions.
23+
- To publish locally:
24+
1. Configure your **Sonatype credentials** (`username` and `password`) in `gradle.properties`.
25+
2. Run:
26+
```bash
27+
./gradlew sonatypeCentralUpload
28+
```
29+
- This will push the artifact to the Maven Central registry.
30+

0 commit comments

Comments
 (0)