Skip to content

Commit

Permalink
Explain how to create a snapshot release
Browse files Browse the repository at this point in the history
  • Loading branch information
smillst authored Jan 4, 2023
1 parent 46bd8bc commit c6b4d5c
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/developer/release/README-release-process.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ <h1>Release Process: <small>Annotation File Utilities, Checker Framework</small>
<ul>
<li><a href="#step_by_step">Step by Step</a></li>
<li><a href="#continuous-integration">Continuous integration tests</a></li>
<li><a href="#snapshot_release">Snapshot release</a></li>
<li><a href="#pre_release_checklist">Pre-release Checklist</a></li>
<li><a href="#release_process_overview">Release Process Overview</a>
<ul>
Expand Down Expand Up @@ -246,6 +247,38 @@ <h2 id="continuous-integration">Continuous integration tests</h2>
</li>
</ol>

<h2 id="snapshot_release">Snapshot release</h2>
<p>This section explains how to release the Maven artifacts to the snapshot repository.</p>
<ol>
<li>
Ensure that <code>~/.gradle/gradle.properties</code> includes your <code>SONATYPE_NEXUS_USERNAME</code>
and <code>SONATYPE_NEXUS_PASSWORD</code>.
</li>
<li>
Ensure that the version number in <code>checker-framework/build.gradle</code> ends in <code>-SNAPSHOT</code>.
</li>
<li>
Run <code>./gradlew publish</code> in <code>checker-framework</code>.
</li>
<li>
In the <code>build.gradle</code> file of a project that you want
to use the snapshot version of the Checker Framework:
<pre>
repositories {
...
maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
}

ext.checkerFrameworkVersion = '3.28.1-SNAPSHOT'
dependencies {
compileOnly "org.checkerframework:checker-qual:${checkerFrameworkVersion}"
testCompileOnly "org.checkerframework:checker-qual:${checkerFrameworkVersion}"
checkerFramework "org.checkerframework:checker:${checkerFrameworkVersion}"
}
</pre>
</li>
</ol>

<h2 id="pre_release_checklist">Pre-release Checklist</h2>
<p>If you have not performed a release before you must follow these steps.</p>
<table class="table">
Expand Down

0 comments on commit c6b4d5c

Please sign in to comment.