Add deploy-site.yaml workflow

.github/workflows/deploy-site.yaml

@@ -0,0 +1,88 @@
+#
+# 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 agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name: deploy-site
+
+on:
+  push:
+    branches:
+      - "trunk"
+      - "trunk-site-pro"
+      - "release/*"
+    paths-ignore:
+      - "**.md"
+      - "**.txt"
+
+# Disable all permissions by defaults:
+# Permissions are enabled on a per-job basis.
+permissions: { }
+
+jobs:
+
+  deploy-site-stg:
+    if: github.repository == 'apache/logging-flume' && github.ref_name == 'trunk'
+    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@gha/v0
+    # Write permissions for committing the generated site
+    permissions:
+      contents: write
+    with:
+      asf-yaml-content: |
+        staging:
+          profile: ~
+          whoami: ${{ github.ref_name }}-site-stg-out
+          subdir: content/flume/2.x
+      target-branch: ${{ github.ref_name }}-site-stg-out
+
+  deploy-site-pro:
+    if: github.repository == 'apache/logging-flume' && github.ref_name == 'trunk-site-pro'
+    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@gha/v0
+    # Write permissions for committing the generated site
+    permissions:
+      contents: write
+    with:
+      asf-yaml-content: |
+        publish:
+          profile: ~
+          whoami: ${{ github.ref_name }}-out
+          subdir: content/flume/2.x
+      target-branch: ${{ github.ref_name }}-out
+
+  export-version:
+    if: github.repository == 'apache/logging-flume' && startsWith(github.ref_name, 'release/')
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.export-version.outputs.version }}
+    steps:
+      - name: Export version
+        id: export-version
+        run: |
+          version=$(echo "${{ github.ref_name }}" | sed 's/^release\///')
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+
+  deploy-site-rel:
+    needs: export-version
+    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@gha/v0
+    # Write permissions for committing the generated site
+    permissions:
+      contents: write
+    with:
+      asf-yaml-content: |
+        staging:
+          profile: ~
+          whoami: ${{ github.ref_name }}-site-stg-out
+          subdir: content/flume/${{ needs.export-version.outputs.version }}
+      target-branch: ${{ github.ref_name }}-site-stg-out

.gitignore

@@ -25,5 +25,7 @@ nb-configuration.xml
 # Maven extensions
 .mvn/extensions.xml
 
-# Node dependencies
+# Node.js and dependencies
 /node_modules/
+/node/
+

antora-playbook.yaml

@@ -17,16 +17,17 @@
 
 site:
   title: Apache Flume
-  url: "https://flume.apache.org"
+  url: "https://logging.apache.org/flume/2.x"
   start_page: "flume::index.adoc"
 
 content:
   sources:
     - url: .
       branches: HEAD
       start_paths:
-        - src/site/antora
-      edit_url: "https://github.com/apache/logging-flume-site/edit/{refname}/{path}"
+        # Generated during the `pre-site` phase from `src/site/antora`, see the `antora` profile of `logging-parent`
+        - target/generated-site/antora
+      edit_url:
 
 asciidoc:
   attributes:

flume-parent/pom.xml

@@ -210,6 +210,8 @@
 
   <properties>
     <flume-project.version>2.0.0-SNAPSHOT</flume-project.version>
+    <!-- The website is generated by Antora from `flume-project`: skip the per-module `maven-site-plugin` sites. -->
+    <maven.site.skip>true</maven.site.skip>
     <!-- Update for year of distribution. Should be set by the maven-release-plugin at release time. -->
     <project.build.outputTimestamp>2022-01-02T00:00:00Z</project.build.outputTimestamp>
     <!-- Set default encoding to UTF-8 to remove maven complaints -->

pom.xml

@@ -101,6 +101,12 @@
     <!-- Dummy value; overwritten by CI at release time. Do not edit manually. -->
     <project.build.outputTimestamp>2026-01-01T00:00:00Z</project.build.outputTimestamp>
 
+    <!-- Flume does not use `log4j-changelog` to generate release notes (there is no `src/changelog` directory). -->
+    <log4j.changelog.skip>true</log4j.changelog.skip>
+
+    <!-- The website is generated by Antora from the root module: skip the per-module `maven-site-plugin` sites. -->
+    <maven.site.skip>true</maven.site.skip>
+
     <!-- `flume-project` is only a reactor aggregator: it is neither installed nor deployed.
          The published children (`flume-dependencies`, `flume-third-party-dependencies`) override these back to `false`. -->
     <maven.install.skip>true</maven.install.skip>

src/site/antora/antora.tmpl.yml

@@ -0,0 +1,23 @@
+#
+# 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 agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name: flume
+title: Apache Flume
+version: ~
+start_page: index.adoc
+nav:
+  - modules/ROOT/nav.adoc