Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 83 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
Metadata data for WildFly.
========================
# Deployment Descriptor Metadata for WildFly

This library is in charge in parsing JakartaEE descriptors and Wildfly extensions.
This library is used for parsing Jakarta EE and WildFly-specific deployment descriptor files to them and creating a Java object model representation of their content.


Building
-------------------
# Building

Prerequisites:

Expand All @@ -18,17 +16,87 @@ To build with your own Maven installation:

mvn install

Releasing
-------------------
# Releasing
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, this whole section was copied from remoting-jmx and mildly tweaked. Thanks to @darranl


To release
```
mvn release:prepare -Prelease
mvn release:perform -Prelease
```
To release JBoss Metadata first checkout the project and ensure you are on the latest commit for the `main` branch with no local changes.

Don't forget to put Final in the release tag name.
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/).

## Prepare the release

Execute:

mvn release:prepare -Pjboss-release

Enter the version being released:

What is the release version for "JBoss Metadata"? (metadata) 17.0.0: 17.0.0.Final

Don't forget to put the qualifier (e.g. Final) in the release tag name.

The tag will default to the version:

What is the SCM release tag or label for "JBoss Metadata"? (metadata) 17.0.0.Final:

Set the next version:

What is the new development version for "JBoss Metadta"? (metadata) 17.0.1.Alpha1-SNAPSHOT: 17.0.1-SNAPSHOT

The release commit can be checked with:

git show ${TAG}

If everything is Ok perform the release which will deploy to Nexus.

## Perform the release

Execute:

mvn release:perform -Pjboss-release

This will deploy the release to the `wildfly-staging` repository.

Wait for 10 minutes then visit the Validation task for the `wildfly-staging` repository in Nexus. 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.

e.g.

> Processed 9 components.
> - no errors were found.
> - the deployment was a dry run (no actual publishing).

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, 9 or more components were scanned and no errors specific to JBoss Metadata are reported.

## Complete the release

If no issues are reported complete the release.

Move the component to the `releases` repository:

git checkout ${TAG}
mvn nxrm3:staging-move
git checkout main

Push the branch and tag to GitHub:

git push upstream main
git push upstream ${TAG}

## Rollback the Release

If the release failed, revert the release.

Delete the component from Nexus:

git checkout ${TAG}
mvn nxrm3:staging-delete
git checkout main

Reset your local Git checkout:

git reset --hard upstream/main
git tag --delete ${TAG}


# License

License
-------
* [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
59 changes: 57 additions & 2 deletions build-config/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,66 @@
<parent>
<groupId>org.jboss</groupId>
<artifactId>jboss-parent</artifactId>
<version>48</version>
<version>50</version>
</parent>

<groupId>org.jboss.metadata</groupId>
<artifactId>metadata-build-config</artifactId>
<name>Metadata Build Configuration</name>
<version>17.0.0-SNAPSHOT</version>

<name>Metadata Build Configuration</name>
<description>Checkstyle configuration for JBoss Metadata</description>
<url>https://github.com/wildfly/metadata</url>

<licenses>
<license>
<name>Apache License 2.0</name>
<url>http://repository.jboss.org/licenses/apache-2.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>

<scm>
<connection>scm:git:git@github.com:wildfly/metadata.git</connection>
<developerConnection>scm:git:git@github.com:wildfly/metadata.git</developerConnection>
<url>https://github.com/wildfly/metadata</url>
</scm>

<developers>
<developer>
<id>wildfly.org</id>
<name>WildFly Community</name>
<organization>wildfly.org</organization>
<organizationUrl>http://wildfly.org</organizationUrl>
</developer>
</developers>

<properties>
<!-- Repository Deployment Settings -->
<nexus.repository.staging>wildfly-staging</nexus.repository.staging>
<nexus.staging.tag>jboss-metadata-${project.version}</nexus.staging.tag>
</properties>

<!-- Maven Central requires javadoc jar. Create an empty one. -->
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<executions>
<execution>
<id>empty-javadoc-jar</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<classifier>javadoc</classifier>
<classesDirectory>${project.basedir}/javadoc</classesDirectory>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
32 changes: 23 additions & 9 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,16 @@
<parent>
<groupId>org.jboss</groupId>
<artifactId>jboss-parent</artifactId>
<version>48</version>
<version>50</version>
</parent>

<groupId>org.jboss.metadata</groupId>
<artifactId>jboss-as-parent-metadata</artifactId>
<version>17.0.0-SNAPSHOT</version>

<name>JBoss Application Server: Metadata Aggregator</name>
<description>JBoss Application Server: Metadata Aggregator</description>
<description>WildFly: Jakarta EE Metadata Aggregator</description>
<url>https://github.com/wildfly/metadata</url>

<packaging>pom</packaging>

Expand All @@ -31,6 +32,22 @@
</license>
</licenses>

<scm>
<connection>scm:git:git@github.com:wildfly/metadata.git</connection>
<developerConnection>scm:git:git@github.com:wildfly/metadata.git</developerConnection>
<url>https://github.com/wildfly/metadata</url>
<tag>HEAD</tag>
</scm>

<developers>
<developer>
<id>wildfly.org</id>
<name>WildFly Community</name>
<organization>wildfly.org</organization>
<organizationUrl>http://wildfly.org</organizationUrl>
</developer>
</developers>

<properties>
<javax.persistence.groupId>org.hibernate.javax.persistence</javax.persistence.groupId>
<javax.persistence.artifactId>hibernate-jpa-2.1-api</javax.persistence.artifactId>
Expand All @@ -39,6 +56,10 @@
<!-- Build configuration -->
<maven.min.version>3.6.0</maven.min.version>

<!-- Repository Deployment Settings -->
<nexus.repository.staging>wildfly-staging</nexus.repository.staging>
<nexus.staging.tag>jboss-metadata-${project.version}</nexus.staging.tag>

<!-- Dependency versions. Please keep alphabetical -->
<version.org.jboss.logging>3.5.0.Final</version.org.jboss.logging>
<version.junit>4.13.2</version.junit>
Expand Down Expand Up @@ -372,11 +393,4 @@
</profile>
</profiles>

<scm>
<connection>scm:git:git@github.com:jboss/metadata.git</connection>
<url>scm:git:git@github.com:jboss/metadata.git</url>
<developerConnection>scm:git:git@github.com:jboss/metadata.git</developerConnection>
<tag>HEAD</tag>
</scm>

</project>
Loading