Skip to content

Commit 1570c7a

Browse files
committed
Update release process instructions
1 parent 809ad49 commit 1570c7a

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -481,7 +481,28 @@ A new snapshot is deployed to sonatype on each commit merged to `main` branch. S
481481

482482
### New release deployment
483483

484-
#### Prerequisites
484+
A new release can be done on demand using `Release new version` workflow. See [release.yml](.github/workflows/release.yml) for details.
485+
486+
#### Steps
487+
1. [Run](https://github.com/scoverage/scoverage-maven-plugin/actions/workflows/release.yml) `Release new version` workflow.
488+
2. Wait ~ 8 hours for sync to maven central.
489+
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.
490+
4. Checkout new tag, e.g. `git checkout scoverage-maven-plugin-2.1.2`.
491+
5. Generate site docs with `mvn clean site -P publicsite` and check that all required docs are generated in `./target/site`.
492+
6. Checkout `gh-pages` branch, e.g. `git checkout gh-pages`.
493+
7. Copy generated site to new directory named as version number, e.g. `cp -r ./target/site ./2.1.2`, commit and push.
494+
8. Wait several seconds for the docs to be published and verify, e.g. https://scoverage.github.io/scoverage-maven-plugin/2.1.2/check-mojo.html.
495+
9. Checkout `main` branch, e.g. `git checkout main`.
496+
10. Update versions in README, e.g. `sed -i 's/2.1.0/2.1.2/g' README.md`, commit and push.
497+
11. Create new Release on GitHub.
498+
499+
500+
This process will be fully or partially automated in the future.
501+
502+
503+
#### Releasing locally
504+
505+
###### Prerequisites
485506
Set sonatype credentials in `~/.m2/settings.xml`:
486507

487508
```xml
@@ -497,24 +518,12 @@ Set sonatype credentials in `~/.m2/settings.xml`:
497518
```
498519
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.
499520

500-
#### Steps
521+
###### Steps
501522

502523
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.1.2`.
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.1.2`, 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.1.2/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.1.0/2.1.2/g' README.md`, commit and push.
513-
11. Create new Release on GitHub.
514-
524+
`mvn -ntp -B release:clean release:prepare release:perform -P release -Darguments="-DskipTests"`.
525+
2. Follow steps 2-11 above
515526

516-
This process will be fully or partially automated in the future.
517-
518527
## License
519528
```
520529
This software is licensed under the Apache 2 license, quoted below.

0 commit comments

Comments
 (0)