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
The following commit(s) were added to refs/heads/use-native-jekyll by this push:
new 7370f38 UNOMI-788 : adapt unomi site generation release doc update
7370f38 is described below
commit 7370f38c8ad146e42d11ac5ce5ea61884e699e3b
Author: David Griffon <[email protected]>
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 | 40 +++++++++++++++++----------
1 file changed, 25 insertions(+), 15 deletions(-)
diff --git a/src/main/webapp/contribute/release-guide.html
b/src/main/webapp/contribute/release-guide.html
index 0507b2f..db03e57 100644
--- a/src/main/webapp/contribute/release-guide.html
+++ b/src/main/webapp/contribute/release-guide.html
@@ -245,26 +245,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: