Skip to content

Commit a06243a

Browse files
committed
Add maven-plugin to releases, update release instructions
Signed-off-by: Appu Goundan <[email protected]>
1 parent 072302e commit a06243a

File tree

3 files changed

+33
-37
lines changed

3 files changed

+33
-37
lines changed

.github/workflows/release-sigstore-java-from-tag.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Release sigstore-java to Maven Central
1+
name: Release sigstore-java and sigstore-maven-plugin to Maven Central
22
on:
33
workflow_dispatch:
44
# user is expected to use a tag as the branch to run the action on
@@ -51,7 +51,7 @@ jobs:
5151

5252
- name: Build, Sign and Release to Maven Central
5353
run: |
54-
./gradlew clean :sigstore-java:publishMavenJavaPublicationToSonatypeRepository -Prelease
54+
./gradlew clean :sigstore-java:publishMavenJavaPublicationToSonatypeRepository :sigstore-maven-plugin:publishMavenJavaPublicationToSonatypeRepository -Prelease
5555
env:
5656
ORG_GRADLE_PROJECT_signingKey: ${{ secrets.PGP_PRIVATE_KEY }}
5757
ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.PGP_PASSPHRASE }}

RELEASING.md

Lines changed: 29 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,41 @@
11
# Releasing
22

3-
At the moment, this release only the `sigstore-java` library
3+
Release is done on github. Do not release from your local machine.
44

5-
## Creating a release
6-
Use the action "Tag and Build Release" with the version (ex `0.5.3`) to create a new release on github. It will
7-
- tag `main` (or a branch) with `v0.5.3`
8-
- create a new release with name `v0.5.3` containing
9-
- all `sigstore-java` artifacts
10-
- a slsa attesation for the release build
5+
## Create a tag
116

12-
#### Reverting a failed release (Github only)
13-
If a release build fails for any reason or the resulting artifacts are not as expected, you must clean-up
14-
any tags or releases built during the action
15-
1. Delete the release from [Releases](https://github.com/sigstore/sigstore-java/releases)
16-
2. Delete the tag from [Tags](https://github.com/sigstore/sigstore-java/tags)
17-
18-
## Building a release bundle for maven central
7+
Tag the release at the version you wish (ex `v0.5.3`), this *MUST* match the project version (`0.5.3`). See version info in [gradle.properties](gradle.properties).
198

20-
The local release script requires you to have `cosign` and `gpg` installed. It
21-
- downloads the latest release from github (ex `v0.5.3`)
22-
- signs all artifacts (except slsa attestation) with cosign
23-
- signs *everything* with gpg to satisfy maven central
24-
- bundles all the files into `sigstore-java-0.5.3-bundle.jar`
9+
## Release `sigstore-java` and `sigstore-maven-plugin`
2510

26-
```
27-
$ cd ./scripts
28-
$ ./sign_and_bundle_release.sh
29-
```
11+
- Use the "Release sigstore-java and sigstore-maven-plugin to Maven Central" action against the tagged version `v0.5.3'. This action builds, signs and pushes the artifacts to Maven Central.
3012

31-
## Releasing to maven central
13+
#### Complete the release on maven central
3214

3315
Releasing to maven central is a **permanent** action, it cannot be reverted
3416

35-
Upload the bundle:
36-
1. Log into [sonatype (s01)](https://s01.oss.sonatype.org)
37-
2. Click "Staging Upload" on the left navbar
38-
3. Set "Upload Mode" to "Artifact Bundle"
39-
4. Then select `sigstore-java-0.5.3-bundle.jar` that was generated by `sign_and_bundle_release.sh`
40-
5. Click "Upload Bundle"
41-
4217
Release the bundle:
18+
1. Log into [sonatype (s01)](https://s01.oss.sonatype.org)
4319
1. Click "Staging Repositories" on the left navbar
44-
2. Select your artifact and ensure all checks have passed
45-
3. Click "release"
46-
4. If checks are failing, "drop" the bundle and fix the release process
20+
1. Select your artifact, "close" it to begin checks
21+
1. After all checks have passed, "release" it
22+
1. If checks are failing, "drop" the bundle and fix the release process
23+
1. Releases show up on Maven Central roughly 1-2 hours after release
24+
25+
## Release `sigstore-gradle-plugin` to Gradle Plugin Portal
26+
27+
- Use the "Release sigstore gradle plugins to Gradle Plugin Portal" action against the tagged version `v0.5.3'. This action builds, signs and pushes the artifacts to the Gradle Plugin Portal
28+
- There is no follow up here, plugins are auto released on the plugin portal.## Reverting a failed release (Github only)
29+
30+
If a release build fails for any reason or the resulting artifacts are not as expected, you must clean-up
31+
any tags or releases built during the action
32+
1. Delete the release from [Releases](https://github.com/sigstore/sigstore-java/releases)
33+
2. Delete the tag from [Tags](https://github.com/sigstore/sigstore-java/tags)
34+
35+
### Maven Central
36+
37+
You can try to contact support but typically releases are permanent.
38+
39+
### Gradle Plugin Portal
40+
41+
If you wish to revert a release, you must login to the portal using `sigstore-java-releasers` within 7 days to delete a release.

gradle.properties

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ org.gradle.jvmargs=-XX:MaxMetaspaceSize=768m
33
systemProp.org.gradle.kotlin.dsl.precompiled.accessors.strict=true
44

55
group=dev.sigstore
6-
# remember to also update
6+
7+
# remember to also update version in
78
# - SigstoreSignExtension.kt
89
# - build-logic/publishing/build.gradle.kts
910
version=0.11.0

0 commit comments

Comments
 (0)