You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@causeway.apache.org by da...@apache.org on 2023/03/16 11:51:32 UTC
[causeway] 02/02: updates links to nightly etc
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch CAUSEWAY-3345
in repository https://gitbox.apache.org/repos/asf/causeway.git
commit b4aa6eb88f580a97d2bfb0ee5c01cd4d3c2a9ba2
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Mar 16 11:51:10 2023 +0000
updates links to nightly etc
---
README.adoc | 46 ---------------
antora/components/comguide/modules/ROOT/nav.adoc | 1 +
.../modules/ROOT/pages/nightly-builds.adoc | 13 +++-
.../comguide/modules/ROOT/pages/starter-apps.adoc | 18 +++---
.../comguide/modules/ROOT/pages/weekly-builds.adoc | 69 ++++++++++++++++++++++
.../components/docs/modules/ROOT/pages/about.adoc | 13 +++-
.../docs/modules/ROOT/pages/downloads/how-to.adoc | 8 ++-
.../modules/ROOT/pages/landing-page/releases.adoc | 17 ++----
.../ROOT/partials/module-nav/framework.adoc | 6 ++
.../docs/modules/support/partials/module-nav.adoc | 5 --
antora/supplemental-ui/index.html | 10 +---
starters/adoc/modules/starters/pages/about.adoc | 16 ++---
12 files changed, 130 insertions(+), 92 deletions(-)
diff --git a/README.adoc b/README.adoc
index e367957103..97698de0f0 100644
--- a/README.adoc
+++ b/README.adoc
@@ -18,52 +18,6 @@ For help and support, join our https://causeway.apache.org/docs/2.0.0-M9/support
toc::[]
-== Nightly Builds
-
-Nightly builds are available as link:https://github.com/orgs/apache/packages?repo_name=causeway[packages] of this repo.
-
-One way to make them available is to add the following to your `~/.m2/settings.xml` file.
-You will need to add a github token in the location indicated:
-
-[source,xml]
-.~/.m2/settings.xml
-----
-<settings>
- <servers>
- <server>
- <id>github-apache-causeway</id>
- <username>myusername</username> <!--.-->
- <password>ghp_TOKEN_WITH_PACKAGE_REPO_READ_ACCESS</password> <!--.-->
- </server>
- </servers>
- <profiles>
- <profile>
- <id>github-apache-causeway</id>
- <activation>
- <property>
- <name>!skip.github-apache-causeway</name>
- </property>
- </activation>
- <repositories>
- <repository>
- <id>github-apache-causeway</id>
- <url>https://maven.pkg.github.com/apache/causeway</url>
- <snapshots>
- <enabled>true</enabled>
- </snapshots>
- </repository>
- </repositories>
- </profile>
- </profiles>
- <activeProfiles>
- <activeProfile>github-apache-causeway</activeProfile>
- </activeProfiles>
-</settings>
-----
-<.> your github username.
-<.> a corresponding personal token to provide access, as per link:https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages[these docs].
-
-You can find the latest version by browsing the link:https://github.com/apache/causeway/packages/1304938[org.apache.causeway.core.causeway-applib] package.
== Core Features
diff --git a/antora/components/comguide/modules/ROOT/nav.adoc b/antora/components/comguide/modules/ROOT/nav.adoc
index 59e37e2f74..26024cf869 100644
--- a/antora/components/comguide/modules/ROOT/nav.adoc
+++ b/antora/components/comguide/modules/ROOT/nav.adoc
@@ -8,6 +8,7 @@
* Nightly
** xref:nightly-builds.adoc[Nightly Builds]
** xref:nightly-deploys.adoc[Nightly Deploys]
+** xref:weekly-builds.adoc[Weekly Builds]
* Release
** xref:cutting-a-release.adoc[Cutting a Release]
** xref:verifying-releases.adoc[Verifying Releases]
diff --git a/antora/components/comguide/modules/ROOT/pages/nightly-builds.adoc b/antora/components/comguide/modules/ROOT/pages/nightly-builds.adoc
index bb178bd82e..67ea43d13f 100644
--- a/antora/components/comguide/modules/ROOT/pages/nightly-builds.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/nightly-builds.adoc
@@ -5,8 +5,19 @@
:page-partial:
A nightly build of the framework is performed at the link:https://github.com/apache-causeway-committers/causeway-nightly[apache-causeway-committers/causeway-nightly] repo.
+The README of that repo describes how to setup your `pom.xml` to download the packages.
-This also includes a preview of the website, accessible link:https://apache-causeway-committers.github.io/causeway-nightly/[here].
+A preview of the website if also generated nightly, and is accessible link:https://apache-causeway-committers.github.io/causeway-nightly/[here].
+[WARNING]
+====
+*These nightly builds should not be used in production.*
+
+Nightly builds are interim builds that are untested and unsupported.
+
+These unreleased builds may have undocumented features, known and unknown defects, and any number of other issues.
+
+They are intended for use by developers and others wishing to help with the development of the framework.
+====
diff --git a/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc b/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc
index 11ebbcba2f..9802c2f0c7 100644
--- a/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc
@@ -8,24 +8,24 @@
When making updates for simpleapp, use the following process:
-=== If the change applies to released (M5):
+=== If the change applies to the currently released version:
-. make change to jdo, then merge down to jdo-SNAPSHOT
-. also merge jdo -> jpa, and fix any persistence differences if nec.
+. make change to jpa, then merge down to jpa-SNAPSHOT
+. also merge jpa -> jdo, and fix any persistence differences if nec.
. then merge jpa -> jpa-SNAPSHOT
-. finally, merge jdo-SNAPSHOT -> jpa-SNAPSHOT (should be a no-op)
+. finally, merge jpa-SNAPSHOT -> jdo-SNAPSHOT (should be a no-op)
Doing it this way makes it easy to keep the branches in sync.
-=== If the change applies to snapshot (M6), then its similar but shorter:
+=== If the change applies to the current snapshot, then simply:
-. make change to jdo-SNAPSHOT
-. merge jdo-SNAPSHOT to jpa-SNAPSHOT, and fix any persistence differences
+. make change to jpa-SNAPSHOT
+. merge jpa-SNAPSHOT to jdo-SNAPSHOT, and fix any persistence differences
[NOTE]
====
-If you do want to update the antora docs and have them updated on-line, then the procedure is to check out the released branch (M5) and make changes there.
-Then we build and copy over to the apache/causeway-site repo to publish up to causeway.apache.org.
+If you do want to update the antora docs and have them updated on-line, then the procedure is to check out the currently released branch and make changes there.
+Then we build and copy over to the `apache/causeway-site` repo to publish up to https://causeway.apache.org.
====
diff --git a/antora/components/comguide/modules/ROOT/pages/weekly-builds.adoc b/antora/components/comguide/modules/ROOT/pages/weekly-builds.adoc
new file mode 100644
index 0000000000..a544e0e838
--- /dev/null
+++ b/antora/components/comguide/modules/ROOT/pages/weekly-builds.adoc
@@ -0,0 +1,69 @@
+[[weekly-builds]]
+= Weekly Builds
+
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+:page-partial:
+
+CAUTION: weekly builds are currently disabled.
+
+A weekly build of the framework is performed in the main link:https://github.com/apache/causeway[apache/causeway] repo, and are available as link:https://github.com/orgs/apache/packages?repo_name=causeway[packages] of this repo.
+
+
+[WARNING]
+====
+*These weekly builds should not be used in production.*
+
+Weekly builds are interim builds that are untested and unsupported.
+
+These unreleased builds may have undocumented features, known and unknown defects, and any number of other issues.
+
+They are intended for use by developers and others wishing to help with the development of the framework.
+====
+
+
+== Authentication Access
+
+To use the weekly builds, you need authenticated access using your github credentials.
+
+One way to do this is to add the following to your `~/.m2/settings.xml` file.
+
+[source,xml]
+.~/.m2/settings.xml
+----
+<settings>
+ <servers>
+ <server>
+ <id>github-apache-causeway</id>
+ <username>myusername</username> <!--.-->
+ <password>ghp_TOKEN_WITH_PACKAGE_REPO_READ_ACCESS</password> <!--.-->
+ </server>
+ </servers>
+ <profiles>
+ <profile>
+ <id>github-apache-causeway</id>
+ <activation>
+ <property>
+ <name>!skip.github-apache-causeway</name>
+ </property>
+ </activation>
+ <repositories>
+ <repository>
+ <id>github-apache-causeway</id>
+ <url>https://maven.pkg.github.com/apache/causeway</url>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+ </repositories>
+ </profile>
+ </profiles>
+ <activeProfiles>
+ <activeProfile>github-apache-causeway</activeProfile>
+ </activeProfiles>
+</settings>
+----
+<.> your github username.
+<.> a corresponding personal token to provide access, as per link:https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages[these docs].
+
+You can find the latest version by browsing the link:https://github.com/apache/causeway/packages/1304938[org.apache.causeway.core.causeway-applib] package.
+
diff --git a/antora/components/docs/modules/ROOT/pages/about.adoc b/antora/components/docs/modules/ROOT/pages/about.adoc
index 414302471f..db30fa2743 100644
--- a/antora/components/docs/modules/ROOT/pages/about.adoc
+++ b/antora/components/docs/modules/ROOT/pages/about.adoc
@@ -116,10 +116,11 @@ _Releases_
* xref:docs:ROOT:downloads/how-to.adoc[Downloads]
* xref:relnotes:ROOT:about.adoc[Release Notes]
-_Nightly Builds_
+_Interim Builds_
-* link:https://github.com/apache/causeway[Packages] (ASF hosted)
-* link:https://github.com/apache-causeway-committers/causeway-nightly[Packages] (not ASF hosted)
+* xref:comguide:ROOT:nightly-builds.adoc[]
+* xref:comguide:ROOT:nightly-deploys.adoc[]
+* xref:comguide:ROOT:weekly-builds.adoc[]
* link:https://apache-causeway-committers.github.io/causeway-nightly[Website preview] (not ASF hosted)
@@ -136,6 +137,12 @@ _Automated Analysis_
* link:https://sonarcloud.io/dashboard?id=apache_causeway[SonarCloud.io]
+_Interim Builds_
+
+* xref:comguide:ROOT:nightly-builds.adoc[]
+* xref:comguide:ROOT:weekly-builds.adoc[]
+* link:https://apache-causeway-committers.github.io/causeway-nightly[Website Preview]
+
_Development_
* xref:core:ROOT:about.adoc[]
diff --git a/antora/components/docs/modules/ROOT/pages/downloads/how-to.adoc b/antora/components/docs/modules/ROOT/pages/downloads/how-to.adoc
index ddf674d6d2..705b66e17a 100644
--- a/antora/components/docs/modules/ROOT/pages/downloads/how-to.adoc
+++ b/antora/components/docs/modules/ROOT/pages/downloads/how-to.adoc
@@ -26,7 +26,7 @@ If you want to build Apache Causeway from formally released source tarballs, you
-== Verifying Releases
+=== Verifying Releases
It is essential that you verify the integrity of any downloaded files using the PGP or MD5 signatures.
For more information on signing artifacts and why we do it, check out the http://www.apache.org/dev/release-signing.html[Release Signing FAQ].
@@ -94,3 +94,9 @@ The http://projects.apache.org/doap.html[description of a project] RDF file for
+== Interim Builds
+
+If you want to track the latest developments, there are also xref:comguide:ROOT:nightly-builds.adoc[nightly builds] and xref:comguide:ROOT:weekly-builds.adoc[weekly builds].
+
+Although these are maintained by the framework’s committers, do be aware that *these are not official ASF releases*.
+
diff --git a/antora/components/docs/modules/ROOT/pages/landing-page/releases.adoc b/antora/components/docs/modules/ROOT/pages/landing-page/releases.adoc
index 81254b7f85..b7136752e5 100644
--- a/antora/components/docs/modules/ROOT/pages/landing-page/releases.adoc
+++ b/antora/components/docs/modules/ROOT/pages/landing-page/releases.adoc
@@ -22,23 +22,16 @@ If your app inherits from the xref:docs:parent-pom:about.adoc[Parent POM], then
<.> update as required.
-== Nightly Builds
-If you like to live on the bleeding edge, there are also nightly builds of the framework.
+== Building from Source
-* link:https://github.com/apache/causeway[Packages] (ASF hosted)
-+
-Requires github credentials to download packages
+You can also xref:docs:ROOT:downloads/how-to.adoc[download] the source code and build it directly.
-* link:https://github.com/apache-causeway-committers/causeway-nightly[Packages] (not ASF hosted)
-+
-Packages can be downloaded without authentication.
-* link:https://apache-causeway-committers.github.io/causeway-nightly[Website preview] (not ASF hosted)
-Although these are maintained and used by the framework's committers, do be aware that *these are _not_ official ASF releases*; they are provided as a convenience only.
+== Interim Builds
-== Building from Source
+If you want to track the latest developments, there are also xref:comguide:ROOT:nightly-builds.adoc[nightly builds] and xref:comguide:ROOT:weekly-builds.adoc[weekly builds].
-If you want though you can also xref:docs:ROOT:downloads/how-to.adoc[download] the source code and build it directly.
+Although these are maintained by the framework’s committers, do be aware that *these are not official ASF releases*.
diff --git a/antora/components/docs/modules/ROOT/partials/module-nav/framework.adoc b/antora/components/docs/modules/ROOT/partials/module-nav/framework.adoc
index 6f63b4dc3c..a76d4773ca 100644
--- a/antora/components/docs/modules/ROOT/partials/module-nav/framework.adoc
+++ b/antora/components/docs/modules/ROOT/partials/module-nav/framework.adoc
@@ -12,6 +12,12 @@
** Automated Analysis
*** link:https://sonarcloud.io/dashboard?id=apache_causeway[SonarCloud.io]
+** Interim Builds
+
+*** xref:comguide:ROOT:nightly-builds.adoc[]
+*** xref:comguide:ROOT:weekly-builds.adoc[]
+*** link:https://apache-causeway-committers.github.io/causeway-nightly[Website Preview]
+
** Development
diff --git a/antora/components/docs/modules/support/partials/module-nav.adoc b/antora/components/docs/modules/support/partials/module-nav.adoc
index d41584d0ee..6101112765 100644
--- a/antora/components/docs/modules/support/partials/module-nav.adoc
+++ b/antora/components/docs/modules/support/partials/module-nav.adoc
@@ -15,9 +15,4 @@
*** xref:relnotes:ROOT:about.adoc[Release Notes]
-** Nightly Builds
-
-*** link:https://github.com/apache/causeway[Packages] (ASF hosted)
-*** link:https://github.com/apache-causeway-committers/causeway-nightly[Packages] (not ASF hosted)
-*** link:https://apache-causeway-committers.github.io/causeway-nightly[Website preview] (not ASF hosted)
diff --git a/antora/supplemental-ui/index.html b/antora/supplemental-ui/index.html
index 8c7975a947..01fee003f8 100644
--- a/antora/supplemental-ui/index.html
+++ b/antora/supplemental-ui/index.html
@@ -113,7 +113,6 @@
<ul>
<li><a href="docs/latest/about.html">Table of Contents</a></li>
<li><hr/></li>
- <li><a href="docs/latest/starters/about.html">Starter Apps</a></li>
<li><a href="docs/latest/landing-page/guides.html">Guides</a></li>
<li><a href="docs/latest/landing-page/components.html">Components</a></li>
<li><a href="docs/latest/landing-page/catalogs.html">Catalogs</a></li>
@@ -122,20 +121,17 @@
<li class="menu-has-children">
<a href="#">Download</a>
<ul>
- <li><a href="#call-to-action">Quick Start</a></li>
+ <li><a href="docs/latest/starters/about.html">Starter Apps</a></li>
<li><a href="docs/latest/downloads/how-to#formal-releases">Source Releases</a></li>
<li><a href="docs/latest/landing-page/releases.html">Binary Releases</a></li>
<li><a href="docs/latest/downloads/how-to#source-code">Source @ Github</a></li>
</ul>
</li>
- <li><a href="#contact">Support</a></li>
<li class="menu-has-children">
<a href="">ASF</a>
<ul>
- <!--
- <li><a href="#team">Our Committers</a></li>
- <li><hr/></li>
- -->
+ <li><a href="#contact">Support</a></li>
+ <li><hr/></li>
<li><a href="https://www.apache.org/">Apache Home Page</a></li>
<li><a href="https://www.apache.org/events/current-event">Events</a></li>
<li><a href="https://www.apache.org/licenses/">Licenses</a></li>
diff --git a/starters/adoc/modules/starters/pages/about.adoc b/starters/adoc/modules/starters/pages/about.adoc
index a7ffe7fb16..a126e69658 100644
--- a/starters/adoc/modules/starters/pages/about.adoc
+++ b/starters/adoc/modules/starters/pages/about.adoc
@@ -11,14 +11,14 @@ The helloworld app is a very minimal app, intended just as a starting point to l
The source code is in this link:https://github.com/apache/causeway-app-helloworld[git repo] which you can either fork, or just download as a zip:
-* use JDO as the ORM, use:
-+
-include::helloworld-script-jdo.adoc[]
-
* to use JPA as the ORM, use:
+
include::helloworld-script-jpa.adoc[]
+* use JDO as the ORM, use:
++
+include::helloworld-script-jdo.adoc[]
+
TIP: A much more complete explanation of the structure of the app (and how to use it) can be found *xref:docs:starters:helloworld.adoc[here]*.
@@ -30,14 +30,14 @@ It also includes some xref:testing:integtestsupport:about.adoc[integration tests
The source code can be found in this link:https://github.com/apache/causeway-app-simpleapp[git repo] which you can either fork, or just download as a zip:
-* to use JDO as the ORM, use:
-+
-include::simpleapp-script-jdo.adoc[]
-
* to use JPA for the ORM, use:
+
include::simpleapp-script-jpa.adoc[]
+* to use JDO as the ORM, use:
++
+include::simpleapp-script-jdo.adoc[]
+
TIP: A much more complete explanation of the structure of the app (and how to use it) can be found *xref:docs:starters:simpleapp.adoc[here]*.