summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Moger <james.moger@gitblit.com>2016-04-04 21:04:38 -0400
committerJames Moger <james.moger@gitblit.com>2016-04-04 21:04:38 -0400
commit031f5b553bd9d29f21bcce971f6544e61d0deff7 (patch)
tree31955c497b061a8a86daab7491ac0103eb6204b0
parent4d4d527a03a2f78eb5108e6e1f56da4188554e9a (diff)
downloadiciql-031f5b553bd9d29f21bcce971f6544e61d0deff7.tar.gz
iciql-031f5b553bd9d29f21bcce971f6544e61d0deff7.zip
Documentation
-rw-r--r--README.md (renamed from README.markdown)0
-rw-r--r--RELEASE.md53
2 files changed, 53 insertions, 0 deletions
diff --git a/README.markdown b/README.md
index b57ec84..b57ec84 100644
--- a/README.markdown
+++ b/README.md
diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000..5c05e03
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,53 @@
+## Releasing
+
+These are quick notes on using Maven to release artifacts to Sonatype.
+
+### Snapshots
+
+To release a snapshot to [Sonatype OSS Snapshots repository](https://oss.sonatype.org/content/repositories/snapshots/):
+
+ mvn clean deploy
+
+### Releases
+
+Releases are deployed to [Sonatype OSSRH Staging](http://central.sonatype.org/pages/releasing-the-deployment.html) and then manually synced to Central.
+
+To release with automated versioning and SCM integration:
+
+ mvn release:clean release:prepare
+ mvn release:perform
+
+To release manually:
+
+ mvn versions:set -DnewVersion=1.2.3
+ mvn clean deploy -P release
+
+### Settings.xml
+
+Sonatype uploads are authenticated and require credentials.
+GPG signing requires a passphrase to unlock the signing key.
+Both of these secrets can be stored in `~/.m2/settings.xml`.
+
+```xml
+<settings>
+ <servers>
+ <server>
+ <id>ossrh</id>
+ <username>jira-username</username>
+ <password>jira-password</password>
+ </server>
+ </servers>
+ <profiles>
+ <profile>
+ <id>ossrh</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <properties>
+ <gpg.executable>gpg</gpg.executable>
+ <gpg.passphrase>gpg-password</gpg.passphrase>
+ </properties>
+ </profile>
+ </profiles>
+</settings>
+```