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

Update on release documentation #312

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Update on release documentation #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 6 additions & 7 deletions docs/release-guide.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,22 +57,21 @@ <h2 id="maven-release-guide">Maven Release Guide</h2>
<p>The release artifacts for each project are deployed to the Maven repository. Making release artefacts should follow the following steps:</p>
<h3 id="only-once-your-configuration-setup">Only once your configuration Setup</h3>
<ol>
<li><strong>Maven Repro Access</strong><br>Make sure you have access to Maven repro via our <a href="https://issues.sonatype.org/browse/OSSRH-960">Sonatype JIRA issue</a>. Add your <a href="https://oss.sonatype.org/#profile;User%20Token">user token</a> (to be found your profile of <a href="https://oss.sonatype.org">https://oss.sonatype.org</a>) to your local <a href="https://maven.apache.org/settings.html">&lt;USER_HOME&gt;/.m2/settings.xml</a> file.</li>
<li><strong>Maven Repro Access</strong><br>Make sure you have access to Maven repro via our <a href="https://issues.sonatype.org/browse/OSSRH-960">Sonatype JIRA issue</a>. After this, you should be able to log in at <a href="https://oss.sonatype.org/#welcome">https://oss.sonatype.org/#welcome</a>. When logged in, will find in your profile a <a href="https://oss.sonatype.org/#profile;User%20Token">user token</a>. This token along with the according user name have to be added to your local <a href="https://maven.apache.org/settings.html">&lt;USER_HOME&gt;/.m2/settings.xml</a> file. Something equivalent to:</li>
</ol>
<p>Something equivalent to:</p>
<div class="codehilite">
<pre><code class="language-shell"> &lt;server&gt;
&lt;id&gt;ossrh&lt;/id&gt;
&lt;username&gt;FOO&lt;/username&gt;
&lt;password&gt;BAR&lt;/password&gt;&lt;!-- being the given token --&gt;
&lt;username&gt;YOUR_USER_NAME&lt;/username&gt;&lt;!-- from your profile --&gt;
&lt;password&gt;YOUR_PASSWORD&lt;/password&gt;&lt;!-- being the given token --&gt;
&lt;/server&gt;
</code></pre>
</div>
<p>After this, you should be able to log in at <a href="https://oss.sonatype.org/#welcome">https://oss.sonatype.org/#welcome</a>.</p>
<ol start="2">
<li> <p><strong>Install GNU PG</strong><br>Install in your OS. <a href="https://dzone.com/articles/publish-your-artifacts-to-maven-central">See details in tutorial 'publish your artifacts to Maven'</a></p> </li>
<li> <p><strong>Configure GNU PG</strong><br>Add your GNU and JIRA credentials to your local <a href="https://maven.apache.org/settings.html">&lt;USER_HOME&gt;/.m2/settings.xml</a>. See <a href="docs/settings-example.xml">our example settings.xml</a> and search &amp; replace the placeholders starting with 'YOUR_'.</p> </li>
<li> <p><strong>Install GNU PG</strong><br> GNU PG is necessary to sign the packages of our release. <br>Install for your OS. <a href="https://dzone.com/articles/publish-your-artifacts-to-maven-central">See details in tutorial 'publish your artifacts to Maven'</a></p> </li>
<li> <p><strong>Configure GNU PG</strong><br>Add your GNU credentials (and you might as well your GIT credentials) to your local <a href="https://maven.apache.org/settings.html">&lt;USER_HOME&gt;/.m2/settings.xml</a>.</p> </li>
</ol>
<p><strong>NOTE:</strong><br> See <a href="docs/settings-example.xml">our example settings.xml</a> and search &amp; replace the placeholders starting with 'YOUR_'.</p>
<h3 id="recipe-for-every-release">Recipe for every release</h3>
<p>There are two kinds of releases a quick SNAPSHOT release, where the SNAPSHOT will be exchanged by a timestamp or the final release.</p>
<h4 id="snapshot-release">Snapshot Release</h4>
Expand Down
16 changes: 9 additions & 7 deletions src/site/site/content/odftoolkit_website/release-guide.mdtext
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,25 @@ The release artifacts for each project are deployed to the Maven repository. Mak

### Only once your configuration Setup

1. **Maven Repro Access**</br>Make sure you have access to Maven repro via our [Sonatype JIRA issue](https://issues.sonatype.org/browse/OSSRH-960). Add your [user token](https://oss.sonatype.org/#profile;User%20Token) (to be found your profile of <https://oss.sonatype.org>) to your local [&lt;USER_HOME&gt;/.m2/settings.xml](https://maven.apache.org/settings.html) file.

1. **Maven Repro Access**</br>Make sure you have access to Maven repro via our [Sonatype JIRA issue](https://issues.sonatype.org/browse/OSSRH-960). After this, you should be able to log in at <https://oss.sonatype.org/#welcome>.
When logged in, will find in your profile a [user token](https://oss.sonatype.org/#profile;User%20Token). This token along with the according user name have to be added to your local [&lt;USER_HOME&gt;/.m2/settings.xml](https://maven.apache.org/settings.html) file.
Something equivalent to:

```shell
<server>
<id>ossrh</id>
<username>FOO</username>
<password>BAR</password><!-- being the given token -->
<username>YOUR_USER_NAME</username><!-- from your profile -->
<password>YOUR_PASSWORD</password><!-- being the given token -->
</server>
```

After this, you should be able to log in at <https://oss.sonatype.org/#welcome>.
2. **Install GNU PG**</br>
GNU PG is necessary to sign the packages of our release.
</br>Install for your OS. [See details in tutorial 'publish your artifacts to Maven'](https://dzone.com/articles/publish-your-artifacts-to-maven-central)

2. **Install GNU PG**</br>Install in your OS. [See details in tutorial 'publish your artifacts to Maven'](https://dzone.com/articles/publish-your-artifacts-to-maven-central)
3. **Configure GNU PG**</br>Add your GNU credentials (and you might as well your GIT credentials) to your local [&lt;USER_HOME&gt;/.m2/settings.xml](https://maven.apache.org/settings.html).

3. **Configure GNU PG**</br>Add your GNU and JIRA credentials to your local [&lt;USER_HOME&gt;/.m2/settings.xml](https://maven.apache.org/settings.html).
**NOTE:**</br>
See [our example settings.xml](docs/settings-example.xml) and search & replace the placeholders starting with 'YOUR_'.

### Recipe for every release
Expand Down
Loading