Skip to content

Commit

Permalink
Build of r/15.x from Sun Feb 18 09:05:27 UTC 2024
Browse files Browse the repository at this point in the history
  • Loading branch information
opencastproject committed Feb 18, 2024
1 parent 16932eb commit b53b936
Show file tree
Hide file tree
Showing 17 changed files with 52 additions and 40 deletions.
2 changes: 1 addition & 1 deletion r/15.x/admin/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -796,5 +796,5 @@ <h2 id="release-documentation">Release Documentation</h2>
</html>
<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-02-16 23:00:58.611528+00:00
Build Date UTC : 2024-02-18 09:05:17.534081+00:00
-->
2 changes: 1 addition & 1 deletion r/15.x/admin/installation/source-linux/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ <h3 id="dependency-download">Dependency Download</h3>
<h2 id="building-opencast">Building Opencast</h2>
<p>Automatically build all Opencast modules and assemble distributions for different server types:</p>
<pre><code>cd opencast-dir
mvn clean install
./mvnw clean install
</code></pre>
<p>Deploy all-in-one distribution:</p>
<pre><code>cd build/
Expand Down
2 changes: 1 addition & 1 deletion r/15.x/admin/installation/source-macosx/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ <h2 id="building-opencast">Building Opencast</h2>
<p>Switch to the opencast folder. If you downloaded the tarball, this is the folder you just unpacked (called something
like <code>opencast-community-opencast-[…]</code>). If you chose to download via git, use <code>cd opencast</code>. You can proceed by
building opencast (depending on the folder permissions, you might need to start the command with <code>sudo</code>):</p>
<pre><code>mvn clean install -Pdev
<pre><code>./mvnw clean install -Pdev
</code></pre>
<p>Please be patient, as building Opencast for the first time will take quite long.</p>
<h2 id="configure">Configure</h2>
Expand Down
2 changes: 1 addition & 1 deletion r/15.x/admin/search/search_index.json

Large diffs are not rendered by default.

Binary file modified r/15.x/admin/sitemap.xml.gz
Binary file not shown.
24 changes: 18 additions & 6 deletions r/15.x/commit
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
commit c3868be8162fe85ee01cf11b77f7e4250bd91ae1
Author: Greg Logan <[email protected]>
Date: Fri Feb 16 10:58:21 2024 -0600
commit 3c37786f49dda92e381b01d9e089431f6695c029
Author: Matthias Neugebauer <[email protected]>
Date: Sun Feb 18 10:04:44 2024 +0100

Merge branch 't/5663-Paella7-NavSlides-KD' of harvard-dce/opencast-contrib into r/15.x
Add maven wrapper (#5487)

Pull request #5339
The Maven wrapper is handy if you need to install the necessary Maven
version but cannot upgrade/downgrade or don't want to install Maven at
all.

#5663 Paella7 patches frameList undefined exception
* [ ] have a concise title
* [ ] [close an accompanying
issue](https://help.github.com/en/articles/closing-issues-using-keywords)
if one exists
* [ ] [be against the correct
branch](https://docs.opencast.org/develop/developer/development-process#acceptance-criteria-for-patches-in-different-versions)
* [ ] include migration scripts and documentation, if appropriate
* [ ] pass automated tests
* [ ] have a clean commit history
* [ ] [have proper commit messages (title and body) for all
commits](https://medium.com/@steveamaza/e028865e5791)
2 changes: 1 addition & 1 deletion r/15.x/developer/develop/admin-ui/development/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ <h2 id="live-working-with-a-mockup">Live working with a Mockup</h2>
<h2 id="update-node-dependencies">Update Node Dependencies</h2>
<p>Installing <code>npm-check-updates</code> and running it at the start of developing / improving a component can ensure that the
node modules stays up-to-date and dependency bugs are reduced.</p>
<p><em>Note: Test the build (<code>mvn install</code>, <code>npm install</code>, <code>grunt</code>) thoroughly when upgrading modules as this might cause some
<p><em>Note: Test the build (<code>./mvnw install</code>, <code>npm install</code>, <code>grunt</code>) thoroughly when upgrading modules as this might cause some
unexpected build failures (resetting the grunt version to "grunt": "^0.4.0" might resolve some of the initial issues).</em></p>
<ol>
<li>
Expand Down
8 changes: 4 additions & 4 deletions r/15.x/developer/develop/development-tips/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,12 @@ <h3 id="intellij">IntelliJ</h3>
<h2 id="developer-builds">Developer Builds</h2>
<p>Besides the default <code>dist</code> Maven profile, the assemblies project defines a second <code>dev</code> profile which will cause only
one <code>allinone</code> distribution to be created. It is already unpacked and ready to be started. Activate the profile using:</p>
<pre><code>mvn clean install -Pdev
<pre><code>./mvnw clean install -Pdev
</code></pre>
<p>The administrative user interface needs nodejs to build and phantomjs for testing purposes. These will be downloaded as
prebuilt binaries during the maven build process. If there are no prebuilt binaries for your operating system, you can
build the tools manually and then build opencast using the <code>frontend-no-prebuilt</code> maven profile:</p>
<pre><code>mvn clean install -Pdev,frontend-no-prebuilt
<pre><code>./mvnw clean install -Pdev,frontend-no-prebuilt
</code></pre>
<h2 id="logging-during-builds">Logging During Builds</h2>
<p>While building Opencast, the default log level for Opencast modules is <code>WARN</code>. To increase logging for development,
Expand All @@ -129,7 +129,7 @@ <h2 id="building-single-modules">Building single modules</h2>
<li>Start Opencast and use <code>la -u</code> in the Karaf console to list all installed bundles/modules. Note down the IDs of the
bundles you want to watch.</li>
<li>Use <code>bundle:watch IDs</code> to watch the desired modules, e.g. <code>bundle:watch 190 199</code></li>
<li>Make your changes and rebuild the module (e.g. execute <code>mvn clean install</code> in the module folder).</li>
<li>Make your changes and rebuild the module (e.g. execute <code>./mvnw clean install</code> in the module folder).</li>
<li>Watch how Karaf automatically redeploys the changed jars from your local Maven repository. You can verify that
everything went smoothly by checking the log with <code>log:tail</code>.</li>
</ul>
Expand All @@ -138,7 +138,7 @@ <h2 id="building-single-modules">Building single modules</h2>
<li><a href="https://asciinema.org/a/348132">Opencast development: Watch and reload modules</a></li>
</ul>
<p>The updated bundles are only available in the currently running Karaf instance. To create a Opencast version that has
this changes permanently, you have to run <code>mvn clean install</code> in the the assemblies directory again. Your current
this changes permanently, you have to run <code>./mvnw clean install</code> in the the assemblies directory again. Your current
instance will be deleted by the new assembly!</p>
<p>In several cases the <code>bundle:watch</code> can bring Karaf in an unstable condition, as dependencies between bundles will not
correctly be restored, after the new bundle has been deployed.</p>
Expand Down
2 changes: 1 addition & 1 deletion r/15.x/developer/develop/devops/local-cluster/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<h1 id="configuring-a-local-cluster-for-testing">Configuring a Local Cluster for Testing</h1>
<p>A list of commands to quickly build and configure a local Opencast cluster.</p>
<p>First, build and extract distributions:</p>
<pre><code class="language-sh">mvn clean install
<pre><code class="language-sh">./mvnw clean install
cd build
tar xf opencast-dist-admin-10-SNAPSHOT.tar.gz
tar xf opencast-dist-presentation-10-SNAPSHOT.tar.gz
Expand Down
16 changes: 8 additions & 8 deletions r/15.x/developer/develop/setup-opencast-for-develop/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h1 id="developer-environment-setup">Developer Environment Setup</h1>
<h2 id="tldr">TL;DR</h2>
<pre><code class="language-sh">$ git clone https://github.com/opencast/opencast.git
$ cd opencast
$ mvn clean install -Pdev
$ ./mvnw clean install -Pdev
$ cd build/opencast-dist-develop-*
$ ./bin/start-opencast
</code></pre>
Expand Down Expand Up @@ -137,7 +137,7 @@ <h2 id="install-dependencies">Install Dependencies</h2>
</code></pre>
<h2 id="build-opencast">Build Opencast</h2>
<p>You can now build opencast by changing into your opencast directory and running:</p>
<pre><code>$ mvn clean install [Options]
<pre><code>$ ./mvnw clean install [Options]
</code></pre>
<p>After the successful compilation you can start opencast with:</p>
<pre><code>$ ./build/opencast-dist-develop-*/bin/start-opencast
Expand Down Expand Up @@ -196,23 +196,23 @@ <h3 id="build-single-modules">Build Single Modules</h3>
<li>Start Opencast and use <code>la -u</code> in the Karaf console to list all installed bundles/modules. Note down the IDs of the
bundles you want to watch.</li>
<li>Use <code>bundle:watch IDs</code> to watch the desired modules, e.g. <code>bundle:watch 190 199</code></li>
<li>Make your changes and rebuild the module (e.g. execute <code>mvn clean install</code> in the module folder).</li>
<li>Make your changes and rebuild the module (e.g. execute <code>./mvnw clean install</code> in the module folder).</li>
<li>Watch how Karaf automatically redeploys the changed jars from your local Maven repository. You can verify that
everything went smoothly by checking the log with <code>log:tail</code>.</li>
</ul>
<p>To see this technique in action, you can watch the following short video:</p>
<ul>
<li><a href="https://asciinema.org/a/348132">Opencast development: Watch and reload modules</a></li>
</ul>
<p>The updated bundles are only available in the currently running Karaf instance. To create a Opencast version that contains your changes permanently, you have to run <code>mvn install</code> in the assemblies directory again. </p>
<p>The updated bundles are only available in the currently running Karaf instance. To create a Opencast version that contains your changes permanently, you have to run <code>./mvnw install</code> in the assemblies directory again. </p>
<p>In several cases the <code>bundle:watch</code> can put Karaf in an unstable condition, as dependencies between bundles will not
correctly be restored after the new bundle has been deployed.</p>
<h3 id="examples">Examples</h3>
<h4 id="build-enabling-multiple-threads-experimental">Build enabling multiple threads (Experimental)</h4>
<p>Building with multiple threads decreases the build time significantly.
If you want to enable multiple threads, you can use the following command:</p>
<pre><code>$ mvn clean install -T 1.0C -DskipTests -Pnone
&amp;&amp; cd assemblies &amp;&amp; mvn install -T 1.0C -Dskiptests -Pdev
<pre><code>$ ./mvnw clean install -T 1.0C -DskipTests -Pnone
&amp;&amp; cd assemblies &amp;&amp; ./mvnw install -T 1.0C -Dskiptests -Pdev
&amp;&amp; cd ..
$ ./build/opencast-dist-develop-*/start-opencast
</code></pre>
Expand All @@ -221,11 +221,11 @@ <h4 id="build-enabling-multiple-threads-experimental">Build enabling multiple th
<h4 id="useful-commands-for-testing-purposes">Useful Commands for Testing Purposes</h4>
<p>For a quick build, you can use the following command to skip Opencast's tests.</p>
<pre><code>$ cd opencast
$ mvn clean install -Pdev -DskipTests
$ ./mvnw clean install -Pdev -DskipTests
</code></pre>
<p>To see the whole <code>stacktrace</code> of the installation you can use the following command to disable the trimming.</p>
<pre><code>$ cd opencast
$ mvn clean install -DtrimStackTrace=false
$ ./mvnw clean install -DtrimStackTrace=false
</code></pre>
<p>If you want to start opencast in debug mode, you could use the debug argument:</p>
<pre><code>$ cd build/opencast-dist-develop-*/bin &amp;&amp; ./start-opencast debug
Expand Down
2 changes: 1 addition & 1 deletion r/15.x/developer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -402,5 +402,5 @@ <h1 id="opencast-development-guides">Opencast Development Guides</h1>
</html>
<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-02-16 23:01:00.076942+00:00
Build Date UTC : 2024-02-18 09:05:19.024133+00:00
-->
6 changes: 3 additions & 3 deletions r/15.x/developer/license/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ <h3 id="javascript-libraries">JavaScript Libraries</h3>
</code></pre>
<h3 id="java-libraries-maven-dependencies">Java Libraries / Maven Dependencies</h3>
<p>Java dependencies are listed pre module. Maven provides some helpful tools to list dependencies and even report
libraries. Have a look at the output of <code>mvn dependency:list</code> and <code>mvn dependency:tree</code> or generate a full report for a
module using:</p>
<pre><code>mvn -s settings.xml project-info-reports:dependencies
libraries. Have a look at the output of <code>./mvnw dependency:list</code> and <code>./mvnw dependency:tree</code> or generate a full report
for a module using:</p>
<pre><code>./mvnw -s settings.xml project-info-reports:dependencies
</code></pre>
<p>This will create a file <code>target/site/dependencies.html</code> containing a full report, including the library versions and
licenses.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ <h4 id="pull-request-guidelines">Pull Request Guidelines</h4>
<li>Any actions that would be required for a version upgrade (e.g: from 3.x to 4.x) must be documented in
<code>docs/guides/admin/docs/upgrade.md</code></li>
<li>New features require a release note in <code>docs/guides/admin/releasenotes</code> of at least one line describing the change</li>
<li>The commands <code>mvn clean install</code>, <code>mvn javadoc:javadoc javadoc:aggregate</code>, and <code>mvn site</code> should all succeed</li>
<li>The commands <code>./mvnw clean install</code>, <code>./mvnw javadoc:javadoc javadoc:aggregate</code>, and <code>./mvnw site</code> should all succeed</li>
<li>The licenses of any external libraries used in the pull request comply with the <a href="../../license/">licensing rules</a> both
in terms of the license itself as well as its listing in NOTICES</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h2 id="pushing-artifacts-to-a-maven-repository">Pushing artifacts to a Maven re
<h4 id="pushing-to-your-local-maven-repository">Pushing to your local Maven repository</h4>
<p>The following command will add a file to your local Maven repository. This is useful for testing if your artifacts are
correctly placed prior to pushing to the mainline Nexus repository.</p>
<pre><code>mvn install:install-file \
<pre><code>./mvnw install:install-file \
-Dfile=$filename \
-DgroupId=$groupId \
-DartifactId=$artifactId \
Expand Down Expand Up @@ -211,7 +211,7 @@ <h4 id="pushing-to-maven-central">Pushing to Maven Central</h4>
</code></pre>
<h2 id="pushing-snapshots">Pushing Snapshots</h2>
<p>Snapshots are pushed automatically by the CI servers. For historical purposes, this is accomplished by:</p>
<pre><code class="language-bash">mvn deploy
<pre><code class="language-bash">./mvnw deploy
</code></pre>
<p>To verify, your artifacts can be found <a href="https://oss.sonatype.org/content/repositories/snapshots/org/opencastproject/">here</a>
and <a href="https://oss.sonatype.org/content/groups/staging/org/opencastproject/">here</a>. Note that you cannot (easily) drop
Expand All @@ -226,30 +226,30 @@ <h2 id="pushing-releases">Pushing Releases</h2>
<li>GPG signatures for the binaries, docs, and sources</li>
</ul>
<p>This is automated with the <code>release</code> profile. To push a release run</p>
<pre><code class="language-bash">mvn nexus-staging:deploy -P release
<pre><code class="language-bash">./mvnw nexus-staging:deploy -P release
</code></pre>
<p>This creates a staging repository (https://oss.sonatype.org/content/groups/staging/org/opencastproject/) for your
artifacts. This is always safe to do - you can still rollback all changes with</p>
<pre><code class="language-bash">mvn nexus-staging:drop
<pre><code class="language-bash">./mvnw nexus-staging:drop
</code></pre>
<p>If things do not look ok, fix the issue and redeploy. Once you are confident that everything is ok, you can run</p>
<pre><code class="language-bash">mvn nexus-staging:close
<pre><code class="language-bash">./mvnw nexus-staging:close
</code></pre>
<p>This closes the staging repository, and runs the Sonatype-side tests for things like GPG signatures. If this fails,
correct the issue locally, and redeploy. Once this succeeds, you have two options: drop (to destroy the release) or:</p>
<pre><code class="language-bash">mvn nexus-staging:release
<pre><code class="language-bash">./mvnw nexus-staging:release
</code></pre>
<p>to permanently release the binaries in their current states.</p>
<h2 id="troubleshooting">Troubleshooting</h2>
<p>Sometimes the deploy or close will fail, timing out after 5 minutes waiting for Sonatype. It will complain about
violations of deploy rules - this may or may not actually be true. If you're confident that this is caused by a simple
timeout and not something you have done use one of the following.</p>
<p>To reattempt a deploy use</p>
<pre><code class="language-bash">mvn nexus-staging:deploy-staged
<pre><code class="language-bash">./mvnw nexus-staging:deploy-staged
</code></pre>
<p>This will avoid recompiling, retesting, and resigning all of the binaries.</p>
<p>To reattempt a close use</p>
<pre><code class="language-bash">mvn nexus-staging:close
<pre><code class="language-bash">./mvnw nexus-staging:close
</code></pre>

<br>
Expand Down
4 changes: 2 additions & 2 deletions r/15.x/developer/participate/release-manager/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ <h3 id="release-branch">Release Branch</h3>
<li>
<p>That is it for the release branch. Now update the versions in <code>develop</code> in preparation for the next release:</p>
<pre><code>git checkout develop
mvn versions:set -DnewVersion=8-SNAPSHOT versions:commit
./mvnw versions:set -DnewVersion=8-SNAPSHOT versions:commit
</code></pre>
</li>
<li>
Expand Down Expand Up @@ -413,7 +413,7 @@ <h3 id="releasing">Releasing</h3>
</li>
<li>
<p>Make the version changes for the release:</p>
<pre><code>mvn versions:set -DnewVersion=6.0 versions:commit
<pre><code>./mvnw versions:set -DnewVersion=6.0 versions:commit
</code></pre>
</li>
<li>
Expand Down
2 changes: 1 addition & 1 deletion r/15.x/developer/search/search_index.json

Large diffs are not rendered by default.

Binary file modified r/15.x/developer/sitemap.xml.gz
Binary file not shown.

0 comments on commit b53b936

Please sign in to comment.