Browse Source

Merge pull request #74 from kriegaex/readme-cosmetics

Minor build + release read-me improvements
tags/V1_9_8_M1
Andy Clement 2 years ago
parent
commit
4960952bc2
No account linked to committer's email address
2 changed files with 9 additions and 15 deletions
  1. 1
    1
      docs/developer/BUILD.md
  2. 8
    14
      docs/developer/RELEASE.md

+ 1
- 1
docs/developer/BUILD.md View File

@@ -197,4 +197,4 @@ to clean downloaded libraries in the `lib` module, here are a few more:
In general, you should not combine profiles setting the same properties in contradictory ways. If you need a very
specific build configuration, you might want to use a profile matching your needs most closely and override specific
properties. However, I am not going to share examples for this approach, because generally it is not necessary and also
both error-prone and sensitive to evan small changes in Maven POMs.
both error-prone and sensitive to even small changes in Maven POMs.

+ 8
- 14
docs/developer/RELEASE.md View File

@@ -50,7 +50,7 @@ This only deploys the main artifacts
The AspectJ installer (`installer/target/aspectj-[VERSION].jar`) needs to be published separately, if you wish to make
it available to the public for this snapshot.

To consume a snapshot, use the ossrh repository:
To consume an AspectJ snapshot published this way, use the OSSRH repository in the dependent project's POM:

```xml
<repository>
@@ -59,14 +59,6 @@ To consume a snapshot, use the ossrh repository:
</repository>
```

```xml
<pluginRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</pluginRepository>
```


## Public releases (milestone, release candidate, final)

The artifacts released are the same as for snapshots, the procedure needs a few more steps, though. I am explaining the
@@ -104,11 +96,13 @@ mvn versions:commit
export MAVEN_OPTS="--add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.text=ALL-UNNAMED --add-opens=java.desktop/java.awt.font=ALL-UNNAMED"

# Build and deploy the release to a Nexus staging repository.
# The 'release' profile will activate
# - Maven GPG plugin for signing artifacts (stand by to enter your passpharase!),
# If there is a message 'Failed to execute goal org.apache.maven.plugins:maven-gpg-plugin:1.6:sign' try 'export GPG_TTY=$(tty)' before running the command,
# - Maven Javadoc plugin,
# - Nexus Staging Maven plugin.
# The 'release' profile will activate:
# - Maven GPG plugin for signing artifacts (stand by to enter your passpharase).
# On Windows, a GUI password dialogue should pop up with a recent GnuPG version.
# In case of error 'Failed to execute goal org.apache.maven.plugins:maven-gpg-plugin:1.6:sign',
# try 'export GPG_TTY=$(tty)' before running the command.
# - Maven Javadoc plugin
# - Nexus Staging Maven plugin
# Optionally, use '-DskipTests=true', if you ran all tests before.
mvn -P release clean deploy
```

Loading…
Cancel
Save