Skip to content

Commit faa26e1

Browse files
authored
Document release procedure in README
Added release procedure instructions including GPG setup and Maven commands.
1 parent a0c36cd commit faa26e1

1 file changed

Lines changed: 46 additions & 1 deletion

File tree

README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,49 @@ The versions of all dependencies and plugins that are used by this archetype are
3636
For each archetype, their archetype-resources `pom.xml` is still in Git but in a separate source tree (e.g. `wildfly-jakartaee-ear-archetype/src/main/resources-filtered/archetype-resources/pom.xml`).
3737
When the archetypes are built, their `pom.xml` are filtered with the property values from the parent pom (so their own `version.wildfly.bom` will have the *actual* value of the parent's `version.wildfly.bom`).
3838

39-
The reason of this structure is that we want to evaluate some property values when we built the archetype (for the versions) and keep others that will be evaluate when the project is generated by the archetypes (eg `${rootArtifactId}`) . The latter properties are escaped from filtering by prepending a `\`.
39+
The reason of this structure is that we want to evaluate some property values when we built the archetype (for the versions) and keep others that will be evaluate when the project is generated by the archetypes (eg `${rootArtifactId}`) . The latter properties are escaped from filtering by prepending a `\`.
40+
41+
## Release Procedure
42+
43+
Prior to releasing you should ensure you have your own GPG signing key set up, published to a key server and listed on [wildfly.org](https://www.wildfly.org/contributors/pgp/).
44+
45+
### Prepare the release
46+
47+
Execute:
48+
49+
```
50+
mvn release:prepare -Pjboss-release
51+
```
52+
53+
### Perform the release
54+
55+
Execute:
56+
57+
```
58+
mvn release:perform -Pjboss-release
59+
```
60+
61+
This will deploy the release to the `wildfly-staging` repository.
62+
63+
Wait for 10 minutes then visit the Validation task for the [`wildfly-staging` repository in Nexus](https://repository.jboss.org/nexus/#browse/browse:wildfly-staging). If this task ran at least 10 minutes after the release was deployed check the latest results on the Settings tab and verify that at least one component was processed and that there were no errors. If the task has not run it can be manually kicked off using the Run button.
64+
65+
e.g.
66+
67+
> Processed X components.
68+
> - no errors were found.
69+
> - the deployment was a dry run (no actual publishing).
70+
71+
If others are also deploying at the same time this count could be higher, the important check is that the scan was at least 10 minutes after it was deployed, 1 or more components were scanned and no errors specific to Remoting JMX are reported.
72+
73+
### Complete the release
74+
75+
If no issues are reported complete the release.
76+
77+
Move the component to the releases repository:
78+
79+
```
80+
git checkout <tag of the release>
81+
mvn nxrm3:staging-move
82+
```
83+
84+
Once this is done, the release will be pushed to the `releases` repository in Nexus and then to Maven Central.

0 commit comments

Comments
 (0)