You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASING.md
-50Lines changed: 0 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -100,34 +100,6 @@ Result:
100
100
- Used for reproducible builds and deployments
101
101
-**No separate release branches**: The release workflow pushes directly to the originating branch
102
102
103
-
### CI Workflow Behavior
104
-
105
-
**Important**: Release commits pushed by the automated workflow will **not** trigger other CI workflows (such as build or test workflows). This is because the workflow uses the default `GITHUB_TOKEN`, and GitHub intentionally prevents workflows from triggering other workflows to avoid infinite loops.
106
-
107
-
- The release commits are still valid and properly signed by `github-actions[bot]`
108
-
- Maven Central deployment happens within the release workflow itself
109
-
- If you need CI to run on release commits, you would need to use a Personal Access Token (PAT) instead of `GITHUB_TOKEN`, though this is generally not recommended for releases
110
-
111
-
## Version Numbering
112
-
113
-
This project follows [Semantic Versioning](https://semver.org/):
114
-
115
-
-**MAJOR** version (X): Incompatible API changes
116
-
-**MINOR** version (Y): Backward-compatible functionality additions
117
-
-**PATCH** version (Z): Backward-compatible bug fixes
118
-
119
-
The automated workflow increments the **PATCH** version for the next development iteration.
120
-
121
-
## Manual Override (Not Recommended)
122
-
123
-
For special cases, you can still manually trigger the deprecated "Maven Release (Manual)" workflow:
124
-
125
-
1. Go to [Actions](https://github.com/BerryCloud/xapi-java/actions)
126
-
2. Select "Maven Release (Manual - Deprecated)"
127
-
3. Click "Run workflow"
128
-
129
-
**Note**: This method is deprecated and should only be used if the automated process fails.
130
-
131
103
## Troubleshooting
132
104
133
105
### Release Workflow Failed
@@ -195,25 +167,3 @@ If artifacts don't appear on Maven Central after a successful workflow:
195
167
2. Deployment can take up to 2 hours to sync to Maven Central
196
168
3. Check forany deployment errorsin the workflow logs
197
169
4. Verify GPG signing was successful (check for GPG-related errors)
198
-
199
-
### CI Workflows Not Triggered by Release Commits
200
-
201
-
**This is expected behavior**. Release commits pushed by the automated workflow will not trigger other CI workflows (such as build or test workflows). This is by design:
202
-
203
-
- The workflow uses the default `GITHUB_TOKEN`for authentication
204
-
- GitHub prevents workflows triggered by `GITHUB_TOKEN` from triggering other workflows to avoid infinite loops
205
-
- The release workflow already performs all necessary building, testing, and deployment within itself
206
-
- If you need CI workflows to run on release commits (generally not recommended), you would need to configure a Personal Access Token (PAT) instead
207
-
208
-
## Required Secrets
209
-
210
-
The following GitHub secrets must be configured for releases to work:
211
-
212
-
- `OSSRH_USERNAME`: Sonatype OSSRH username
213
-
- `OSSRH_TOKEN`: Sonatype OSSRH token
214
-
- `MAVEN_GPG_PRIVATE_KEY`: GPG private key for signing artifacts
215
-
- `MAVEN_GPG_PASSPHRASE`: Passphrase for the GPG private key
216
-
217
-
## Snapshot Releases
218
-
219
-
Snapshot versions are automatically published to Maven Central's snapshot repository when changes are pushed to `release-*` branches. See the "Publish snapshot to the Sonatype OSSRH" workflow.
0 commit comments