Skip to content

Commit 854c6f6

Browse files
committed
Update release instructions
1 parent 4dc508d commit 854c6f6

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

+22-5
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,9 @@ Go to one of them and run `mvn site`.
479479
### Snapshot deployment
480480
A new snapshot is deployed to sonatype on each commit merged to `main` branch. See [snapshot.yml](.github/workflows/snapshot.yml) workflow for details.
481481

482-
### Manual Release deployment
482+
### New release deployment
483+
484+
#### Prerequisites
483485
Set sonatype credentials in `~/.m2/settings.xml`:
484486

485487
```xml
@@ -493,10 +495,25 @@ Set sonatype credentials in `~/.m2/settings.xml`:
493495
</servers>
494496
</settings>
495497
```
496-
497-
To deploy release to sonatype release repo run `mvn release:clean release:prepare release:perform -P release`.
498-
Make sure you have proper pgp keys set up.
499-
This process will be automated in the future.
498+
Make sure you have proper pgp keys set up. See [Maven Central Guide](https://central.sonatype.org/pages/working-with-pgp-signatures.html) for details.
499+
500+
#### Steps
501+
502+
1. Run
503+
`mvn -Darguments="-Dmaven.test.skip=true" -B release:clean release:prepare release:perform -P release`.
504+
2. Wait ~ 8 hours for sync to maven central.
505+
3. Check jars are available in maven central https://search.maven.org/artifact/org.scoverage/scoverage-maven-plugin and GH label in README is updated.
506+
4. Checkout new tag, e.g. `git checkout scoverage-maven-plugin-2.0.4`.
507+
5. Generate site docs with `mvn clean site -P publicsite` and check that all required docs are generated in `./target/site`.
508+
6. Checkout `gh-pages` branch, e.g. `git checkout gh-pages`.
509+
7. Copy generated site to new directory named as version number, e.g. `cp -r ./target/site ./2.0.4`, commit and push.
510+
8. Wait several seconds for the docs to be published and verify, e.g. https://scoverage.github.io/scoverage-maven-plugin/2.0.4/check-mojo.html.
511+
9. Checkout `main` branch, e.g. `git checkout main`.
512+
10. Update versions in README, e.g. `sed -i 's/2.0.3/2.0.4/g' README.md`, commit and push.
513+
11. Create new Release on GitHub.
514+
515+
516+
This process will be fully or partially automated in the future.
500517

501518
## License
502519
```

0 commit comments

Comments
 (0)