You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@unomi.apache.org by dg...@apache.org on 2023/08/17 06:23:05 UTC
[unomi-site] 01/01: UNOMI-788 : adapt unomi site generation release doc update
This is an automated email from the ASF dual-hosted git repository.
dgriffon pushed a commit to branch use-native-jekyll
in repository https://gitbox.apache.org/repos/asf/unomi-site.git
commit 7a975a4257bb4a60c6a87d1d307ef4dacdadda6f
Author: David Griffon <dg...@jahia.com>
AuthorDate: Thu Aug 17 08:01:05 2023 +0200
UNOMI-788 : adapt unomi site generation release doc update
---
src/main/webapp/contribute/release-guide.html | 50 +++++++++++++++++----------
1 file changed, 31 insertions(+), 19 deletions(-)
diff --git a/src/main/webapp/contribute/release-guide.html b/src/main/webapp/contribute/release-guide.html
index 0507b2f..20b847e 100644
--- a/src/main/webapp/contribute/release-guide.html
+++ b/src/main/webapp/contribute/release-guide.html
@@ -161,9 +161,11 @@ gpg --verify test.txt.asc test.txt
<li>Setup server passwords for publishing as document here:
<a href="https://www.apache.org/dev/publishing-maven-artifacts.html" target="_blank">https://www.apache.org/dev/publishing-maven-artifacts.html</a> and <a href="https://maven.apache.org/guides/mini/guide-encryption.html#How_to_encrypt_server_passwords" target="_blank">https://maven.apache.org/guides/mini/guide-encryption.html#How_to_encrypt_server_passwords</a>
</li>
- <li>Launch the first build script using
+ <li>Launch the first build script using.
<pre class="alert alert-primary"><code>./release-stage-1.sh ${next.stable.version} BRANCH_NAME</code></pre>
- where BRANCH_NAME is the branch you want to release (It must be created first if it doesn't exist !)
+ where BRANCH_NAME is the branch you want to release (It must be created first if it doesn't exist !).<br>
+ <strong>This step will generate staging artifacts onto the <a href="https://repository.apache.org/#stagingRepositories">Apache Nexus</a>, if at the end of the script the
+ artefacts are not there, something bad happened in the script execution.</strong>
</li>
<li>Check that there are no JARs or ZIP files in the source code, you can do this by looking at the generated RAT report here :
<pre class="alert alert-primary"><code>less target/unomi-root-${next.development.version}.rat</code></pre>
@@ -194,7 +196,7 @@ and run mvn release:perform</code></pre>
</li>
<li>Connect to <a href="https://repository.apache.org/#stagingRepositories" target="_blank">https://repository.apache
.org/#stagingRepositories</a> and look for the open staging repositories, you should have two (one for everything and the other for KAR/features) for releases <= 1.2 and just one for versions >= 1.3.0 (because of changes in the Karaf plugins). Close the repositories and given a meaningful comment when closing such as:<br>
- <strong>Apache Unomi ${next.stable.version} Release Candidate 1</strong>
+ <strong>Apache Unomi ${next.stable.version} Release Candidate 1</strong>. If no artefact related to Unomi is present, something wrong happened in <code>release-stage-1.sh</code>.
</li>
</ol>
@@ -202,7 +204,7 @@ and run mvn release:perform</code></pre>
<ol>
<li>Launch the second stage of the release script
<pre class="alert alert-primary"><code>./release-stage-2.sh ${next.stable.version} orgapacheunomi-NEXUS-UNOMI-ID</code></pre>
- where NEXUS-UNOMI-ID is the ID generated by Nexus
+ where NEXUS-UNOMI-ID is the ID generated by Nexus for the staging artifacts.
</li>
<li>Send out to the Unomi mailing list a mail to start the voting process, see <a href="#mail-1">[1]</a></li>
<li>If the vote is refused or cancelled, peform the following steps to restart the release process:
@@ -245,26 +247,36 @@ git tag -d unomi-root-${next.stable.version}</code></pre>
Be careful with links that contain & (ampersand) characters, they must be replaced with &. Normally all
this should be easy to do by simply search & replacing the version number. Finally on the home page update the news section to add the release.
<pre class="alert alert-primary"><code>git clone https://gitbox.apache.org/repos/asf/unomi-site.git</code></pre>
- Perform any modifications, notably change the versions in the pom.xml file:
- <pre class="alert alert-primary"><code> <properties>
- <latest.stable.version>1.5.4</latest.stable.version>
- <next.development.version>1.5.5-SNAPSHOT</next.development.version>
- <next.stable.version>1.5.5</next.stable.version>
- <latest.development.version>2.0.0-SNAPSHOT</latest.development.version>
- </properties>
-</code></pre>
- Then modify the index.html, download.html to add the new files. For the documentation see the next step.
+ Perform any modifications, notably change the versions in the <code>src/main/webapp/_data/unomi.yml</code> file:
+ <pre class="alert alert-primary"><code>
+ latest:
+ stable:
+ version: 2.3.0
+ .development:
+ version: 2.4.0-SNAPSHOT
+ next:
+ stable:
+ version: 2.4.0
+ ...
+ </code></pre>
+ Then modify the <code>index.html</code>, <code>download.html</code> to add the new files. For the documentation see the next step or git <a href="https://github.com/apache/unomi-site/blob/master/README.md">README</a>.
</li>
<li>
Test the site modifications using the generated site HTML using Jekyll serve
- <pre class="alert alert-primary"><code>./mvnw clean install gem:exec@jekyll-serve-filtered</code></pre>
- Connect to http://127.0.0.1:4000 to check the modifications. If you need to make more modifications,
- simply relaunch the above line after modifying the HTML files.
+ <pre class="alert alert-primary"><code>jekyll serve</code></pre>
+ or by using docker (to not install <a href="https://jekyllrb.com/">Jekyll</a> locally)
+ <pre class="alert alert-primary"><code> docker run --rm \
+ --volume="$PWD:/srv/jekyll:Z" \
+ -p 4000:4000 \
+ jekyll/jekyll:4.2.0 \
+ jekyll serve </code></pre>
+ Connect to <code>http://127.0.0.1:4000</code> to check the modifications. With the docker image source changes are detected and site build automatically.
+ This generates the site in the <code>target/site</code> folder.
</li>
<li>
- Deploy the web site changes using:
- <pre class="alert alert-primary"><code>./mvnw clean install
-./mvnw install scm-publish:publish-scm -Dusername=YOUR_APACHE_USERNAME -Dpassword=YOUR_APACHE_PASSWORD</code></pre>
+ Once the site build, deploy the web site changes using:
+ <pre class="alert alert-primary"><code>
+mvn install scm-publish:publish-scm -Dusername=YOUR_APACHE_USERNAME -Dpassword=YOUR_APACHE_PASSWORD</code></pre>
</li>
<li>
Then make sure to commit all the changes to the web site's git project: