Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

prep for push to maven central #3

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

prep for push to maven central #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8434d52
update pom for central deployment
pwinckles Mar 14, 2023
9fe0a26
add release notes
pwinckles Mar 14, 2023
7a7ee06
move release guide into readme
pwinckles Mar 15, 2023
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
25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
# aes
# aes

## Release

### Maven Central

Pre-reqs:

1. A Sonatype account with access to the LTS group
2. GPG
3. Maven setup with your Sonatype and GPG credentials: https://central.sonatype.org/publish/publish-maven/

Execute the following to publish to central:

```shell
mvn -Prelease-central clean deploy
```

Note:

1. The above command will **not** modify the version. You should use either `mvn release` or `mvn versions:set` to
set the version prior to publishing.
2. The plugin is currently configured to stage the artifact in Central, but **not** release it. To release it, you
must sign in at https://s01.oss.sonatype.org/ and follow [these instructions](https://central.sonatype.org/publish/release/#performing-a-release-deployment-with-the-maven-release-plugin).
153 changes: 124 additions & 29 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@
<packaging>jar</packaging>

<name>AES</name>
<description>AES</description>
<url>https://github.com/harvard-lts/aes31</url>

<licenses>
<license>
<name>The Apache License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
</license>
</licenses>

<scm>
<connection>scm:git:https://github.com/harvard-lts/aes31.git</connection>
Expand All @@ -22,7 +31,7 @@
<java.version>1.8</java.version>
<log4j.version>2.17.2</log4j.version>
<jdom.version>2.0.6.1</jdom.version>
<mvn-compiler-plugin.version>3.8.1</mvn-compiler-plugin.version>
<mvn-compiler-plugin.version>3.11.0</mvn-compiler-plugin.version>
<mvn-jar-plugin.version>3.2.0</mvn-jar-plugin.version>
</properties>

Expand Down Expand Up @@ -56,6 +65,32 @@
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.2.1</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.5.0</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

Expand All @@ -67,34 +102,94 @@
</dependency>
</dependencies>

<repositories>
<repository>
<id>lts-libs-all</id>
<name>Harvard LTS Dependency Repository</name>
<url>${lts-artifactory-url}/lts-libs-all</url>
</repository>
</repositories>

<pluginRepositories>
<pluginRepository>
<id>lts-libs-all-plugins</id>
<name>Harvard LTS Plugin Repository</name>
<url>${lts-artifactory-url}/lts-libs-all</url>
</pluginRepository>
</pluginRepositories>
<profiles>
<profile>
<id>harvard</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>lts-libs-all</id>
<name>Harvard LTS Dependency Repository</name>
<url>${lts-artifactory-url}/lts-libs-all</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>lts-libs-all-plugins</id>
<name>Harvard LTS Plugin Repository</name>
<url>${lts-artifactory-url}/lts-libs-all</url>
</pluginRepository>
</pluginRepositories>
<distributionManagement>
<!-- repository URL and credentials set up in local .m2/settings.xml -->
<repository>
<id>harvard-lts-internal-release-repository</id>
<name>Harvard LTS internal Release Repository</name>
<url>${lts-artifactory-url}/lts-libs-release-local</url>
</repository>
<snapshotRepository>
<id>harvard-lts-internal-snapshot-repository</id>
<name>Harvard LTS internal Snapshot Repository</name>
<url>${lts-artifactory-url}/lts-libs-snapshot-local</url>
</snapshotRepository>
</distributionManagement>
</profile>
<profile>
<!-- Profile for releasing to Maven Central: -Prelease-central -->
<id>release-central</id>
<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
</distributionManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>3.0.1</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.13</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>false</autoReleaseAfterClose>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>

<distributionManagement>
<!-- repository URL and credentials set up in local .m2/settings.xml -->
<repository>
<id>harvard-lts-internal-release-repository</id>
<name>Harvard LTS internal Release Repository</name>
<url>${lts-artifactory-url}/lts-libs-release-local</url>
</repository>
<snapshotRepository>
<id>harvard-lts-internal-snapshot-repository</id>
<name>Harvard LTS internal Snapshot Repository</name>
<url>${lts-artifactory-url}/lts-libs-snapshot-local</url>
</snapshotRepository>
</distributionManagement>
<developers>
<developer>
<name>David Neiman</name>
<email>[email protected]</email>
<organization>Harvard University Information Technology</organization>
<organizationUrl>https://huit.harvard.edu</organizationUrl>
</developer>
<developer>
<name>Andrew Woods</name>
<email>[email protected]</email>
<organization>Harvard University Information Technology</organization>
<organizationUrl>https://huit.harvard.edu</organizationUrl>
</developer>
</developers>

</project>
4 changes: 2 additions & 2 deletions src/main/java/com/therockquarry/aes31/adl/FileSourceIndexEntry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ private void _init ()
* Sets the unique identifier for this <code>FileSurceIndexEntry</code>
* to the value of the <code>uid</code> String, which should contain the
* value of the source audio files Originator Reference field. Validates
* the passed parameter to ensure it is <= 32 characters in length.
* the passed parameter to ensure it is &lt;= 32 characters in length.
*
* @param uid The unique Identifier for the source audio file as found in
* the BEXT chunk's Originator Reference field.
Expand All @@ -141,7 +141,7 @@ public void setUid (String uid) throws InvalidDataException

/**
* Returns the Unique Identifier for the audio file associated with this
* </code>FileSourceIndexEntry</code>.
* <code>FileSourceIndexEntry</code>.
*
* @return A String containing the unique identifier for the audio file
* associated with this <code>FileSourceIndexEntry</code>.
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/therockquarry/aes31/adl/SourceEntry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public SourceEntry (SourceIndexSection parent) throws InvalidDataException
* Constructs a new <code>SourceEntry</code> object.
*
* @param parent The <code>SourceIndexSection</code> to which this <code>SourceEntry</code> belongs.
* @param entries An array of <code>BaseEditEntry</code> objects with which to initialize this <codeSourceEntry</code>.
* @param entries An array of <code>BaseEditEntry</code> objects with which to initialize this <code>SourceEntry</code>.
*/
public SourceEntry (SourceIndexSection parent, BaseIndexEntry[] entries) throws InvalidDataException
{
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/therockquarry/aes31/adl/TracklistSection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ public void addTrackAtIndex (String trackNumber, String trackName) throws Invali
* @param trackNumber The track number where the <code>track</code> parameter will be placed in this <code>TracklistSection</code>.
* @param track The <code>TrackType</code> object to add to this <code>Tracklist</code>.
* @throws InvalidDataException If this <code>TracklistSection</code> already contains an instance of <code>track</code>, or if the <code>
* trackNumber</code> parameter is out of range (<code>trackNumber</code> < 1) or if this <coded>TracklistSection</code> already contains
* trackNumber</code> parameter is out of range (<code>trackNumber</code> &lt; 1) or if this <code>TracklistSection</code> already contains
* an entry at the specified <code>trackNumber</code>.
*/
public void addTrackAtIndex (int trackNumber, TrackType track) throws InvalidDataException
Expand Down Expand Up @@ -179,7 +179,7 @@ protected void addData (String keyword, Vector data, ADLTokenizer tokenizer)
* @param trackNumber The track number position in this <code>TracklistSection</code> to set the <code>track</code> parameter to.
* @param track The <code>TrackType</code> object to add to this <code>Tracklist</code>.
* @throws InvalidDataException If this <code>TracklistSection</code> already contains an instance of <code>track</code>, or if the <code>
* trackNumber</code> parameter is out of range (<code>trackNumber</code> < 1).
* trackNumber</code> parameter is out of range (<code>trackNumber</code> &lt; 1).
*/
public void setTrackAtIndex (int trackNumber, TrackType track) throws InvalidDataException
{
Expand All @@ -202,7 +202,7 @@ public void setTrackAtIndex (int trackNumber, TrackType track) throws InvalidDat
}

/**
* Deletes the <ocde>TrackType</code> specified by the <code>trackNumber</code> parameter from this <code>TracklistSection</code>.
* Deletes the <code>TrackType</code> specified by the <code>trackNumber</code> parameter from this <code>TracklistSection</code>.
* If the track does not exist, this call has no effect.
*
* @param trackNumber The track number of the <code>TrackType</code> to be deleted from this <code>TracklistSection</code>.
Expand Down