Replace Maven Cache with Mimír

.github/workflows/build-reusable.yaml

@@ -89,7 +89,41 @@ jobs:
         with:
           distribution: zulu
           java-version: ${{ inputs.java-version }}
-          cache: maven
+
+      #
+      # Sets up Mimír (https://maveniverse.eu/docs/mimir/) to cache artifacts from remote repositories
+      #
+      # Unlike the local Maven repository, Mimír cannot be used to stage locally generated artifacts or snapshots.
+      # Therefore, it can be reused between builds, even on different architectures.
+      # Since the size of the cache increases in time, as we download new dependency versions, we reset the cache
+      # once a month.
+      #
+      # WARNING: Currently it is not possible to reuse GitHub workflow steps, therefore, these two steps must be
+      #          copied to multiple workflows.
+      #          The `build-reusable` workflow uses `actions/cache`,
+      #          while the other workflows only use `actions/cache/restore`
+      #
+      - name: Set up Mimír configuration
+        shell: bash
+        run: |
+          # Compute the key cache
+          echo MIMIR_KEY="mimir-cache-$(date +'%Y-%m')" >> $GITHUB_ENV
+          # Mimir currently does not support relative paths, so we need to compute the absolute path of `mimir`.
+          echo MAVEN_OPTS="-Dmimir.daemon.passOnBasedir=true -Dmimir.daemon.autostop=true -Dmimir.basedir=$GITHUB_WORKSPACE/.mimir" >> $GITHUB_ENV
+
+      - name: Set up Mimír cache
+        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # 4.2.3
+        with:
+          # Mimir is a partial mirror of Maven Central.
+          # Therefore, we only need to clean it from time to time to remove old versions.
+          #
+          # However, GitHub caches are immutable, and we need a unique key to update them.
+          # If no cache hit occurs for this key, we fall back to any other cache.
+          key: "${{ env.MIMIR_KEY }}-${{ hashFiles('**/pom.xml') }}"
+          restore-keys: |
+            ${{ env.MIMIR_KEY }}-
+          path: .mimir/local
+          enableCrossOsArchive: true
 
       - name: Set up Develocity
         if: inputs.develocity-enabled

.github/workflows/codeql-analysis-reusable.yaml

@@ -53,7 +53,40 @@ jobs:
         with:
           distribution: zulu
           java-version: ${{ inputs.java-version }}
-          cache: maven
+
+      #
+      # Sets up Mimír (https://maveniverse.eu/docs/mimir/) to cache artifacts from remote repositories
+      #
+      # Unlike the local Maven repository, Mimír cannot be used to stage locally generated artifacts or snapshots.
+      # Therefore, it can be reused between builds, even on different architectures.
+      # Since the size of the cache increases in time, as we download new dependency versions, we reset the cache
+      # once a month.
+      #
+      # WARNING: Currently it is not possible to reuse GitHub workflow steps, therefore, these two steps must be
+      #          copied to multiple workflows.
+      #          The `build-reusable` workflow uses `actions/cache`,
+      #          while the other workflows only use `actions/cache/restore`
+      #
+      - name: Set up Mimír configuration
+        shell: bash
+        run: |
+          # Compute the key cache
+          echo MIMIR_KEY="mimir-cache-$(date +'%Y-%m')" >> $GITHUB_ENV
+          # Mimir currently does not support relative paths, so we need to compute the absolute path of `mimir`.
+          echo MAVEN_OPTS="-Dmimir.daemon.passOnBasedir=true -Dmimir.daemon.autostop=true -Dmimir.basedir=$GITHUB_WORKSPACE/.mimir" >> $GITHUB_ENV
+
+      - name: Set up Mimír cache
+        uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684 # 4.2.3
+        with:
+          # Mimir is a partial mirror of Maven Central.
+          # Therefore, we only need to clean it from time to time to remove old versions.
+          #
+          # However, GitHub caches are immutable, and we need a unique key to update them.
+          # If no cache hit occurs for this key, we fall back to any other cache.
+          key: "${{ env.MIMIR_KEY }}-${{ hashFiles('**/pom.xml') }}"
+          restore-keys: |
+            ${{ env.MIMIR_KEY }}-
+          path: .mimir/local
 
       - name: Build with Maven
         shell: bash

.github/workflows/deploy-release-reusable.yaml

@@ -68,12 +68,45 @@ jobs:
         with:
           distribution: zulu
           java-version: ${{ inputs.java-version }}
-          cache: maven
           server-id: apache.releases.https
           server-username: NEXUS_USERNAME
           server-password: NEXUS_PASSWORD
           gpg-private-key: ${{ secrets.GPG_SECRET_KEY }}
 
+      #
+      # Sets up Mimír (https://maveniverse.eu/docs/mimir/) to cache artifacts from remote repositories
+      #
+      # Unlike the local Maven repository, Mimír cannot be used to stage locally generated artifacts or snapshots.
+      # Therefore, it can be reused between builds, even on different architectures.
+      # Since the size of the cache increases in time, as we download new dependency versions, we reset the cache
+      # once a month.
+      #
+      # WARNING: Currently it is not possible to reuse GitHub workflow steps, therefore, these two steps must be
+      #          copied to multiple workflows.
+      #          The `build-reusable` workflow uses `actions/cache`,
+      #          while the other workflows only use `actions/cache/restore`
+      #
+      - name: Set up Mimír configuration
+        shell: bash
+        run: |
+          # Compute the key cache
+          echo MIMIR_KEY="mimir-cache-$(date +'%Y-%m')" >> $GITHUB_ENV
+          # Mimir currently does not support relative paths, so we need to compute the absolute path of `mimir`.
+          echo MAVEN_OPTS="-Dmimir.daemon.passOnBasedir=true -Dmimir.daemon.autostop=true -Dmimir.basedir=$GITHUB_WORKSPACE/.mimir" >> $GITHUB_ENV
+
+      - name: Set up Mimír cache
+        uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684 # 4.2.3
+        with:
+          # Mimir is a partial mirror of Maven Central.
+          # Therefore, we only need to clean it from time to time to remove old versions.
+          #
+          # However, GitHub caches are immutable, and we need a unique key to update them.
+          # If no cache hit occurs for this key, we fall back to any other cache.
+          key: "${{ env.MIMIR_KEY }}-${{ hashFiles('**/pom.xml') }}"
+          restore-keys: |
+            ${{ env.MIMIR_KEY }}-
+          path: .mimir/local
+
       - name: Set up Git user
         shell: bash
         run: |

.github/workflows/deploy-site-reusable.yaml

@@ -61,9 +61,42 @@ jobs:
         with:
           distribution: zulu
           java-version: ${{ inputs.java-version }}
-          cache: maven
           gpg-private-key: ${{ secrets.GPG_SECRET_KEY }}
 
+      #
+      # Sets up Mimír (https://maveniverse.eu/docs/mimir/) to cache artifacts from remote repositories
+      #
+      # Unlike the local Maven repository, Mimír cannot be used to stage locally generated artifacts or snapshots.
+      # Therefore, it can be reused between builds, even on different architectures.
+      # Since the size of the cache increases in time, as we download new dependency versions, we reset the cache
+      # once a month.
+      #
+      # WARNING: Currently it is not possible to reuse GitHub workflow steps, therefore, these two steps must be
+      #          copied to multiple workflows.
+      #          The `build-reusable` workflow uses `actions/cache`,
+      #          while the other workflows only use `actions/cache/restore`
+      #
+      - name: Set up Mimír configuration
+        shell: bash
+        run: |
+          # Compute the key cache
+          echo MIMIR_KEY="mimir-cache-$(date +'%Y-%m')" >> $GITHUB_ENV
+          # Mimir currently does not support relative paths, so we need to compute the absolute path of `mimir`.
+          echo MAVEN_OPTS="-Dmimir.daemon.passOnBasedir=true -Dmimir.daemon.autostop=true -Dmimir.basedir=$GITHUB_WORKSPACE/.mimir" >> $GITHUB_ENV
+
+      - name: Set up Mimír cache
+        uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684 # 4.2.3
+        with:
+          # Mimir is a partial mirror of Maven Central.
+          # Therefore, we only need to clean it from time to time to remove old versions.
+          #
+          # However, GitHub caches are immutable, and we need a unique key to update them.
+          # If no cache hit occurs for this key, we fall back to any other cache.
+          key: "${{ env.MIMIR_KEY }}-${{ hashFiles('**/pom.xml') }}"
+          restore-keys: |
+            ${{ env.MIMIR_KEY }}-
+          path: .mimir/local
+
       - name: Build the project
         shell: bash
         if: inputs.install-required

.github/workflows/deploy-snapshot-reusable.yaml

@@ -51,11 +51,44 @@ jobs:
         with:
           distribution: zulu
           java-version: ${{ inputs.java-version }}
-          cache: maven
           server-id: apache.snapshots.https
           server-username: NEXUS_USERNAME
           server-password: NEXUS_PASSWORD
 
+      #
+      # Sets up Mimír (https://maveniverse.eu/docs/mimir/) to cache artifacts from remote repositories
+      #
+      # Unlike the local Maven repository, Mimír cannot be used to stage locally generated artifacts or snapshots.
+      # Therefore, it can be reused between builds, even on different architectures.
+      # Since the size of the cache increases in time, as we download new dependency versions, we reset the cache
+      # once a month.
+      #
+      # WARNING: Currently it is not possible to reuse GitHub workflow steps, therefore, these two steps must be
+      #          copied to multiple workflows.
+      #          The `build-reusable` workflow uses `actions/cache`,
+      #          while the other workflows only use `actions/cache/restore`
+      #
+      - name: Set up Mimír configuration
+        shell: bash
+        run: |
+          # Compute the key cache
+          echo MIMIR_KEY="mimir-cache-$(date +'%Y-%m')" >> $GITHUB_ENV
+          # Mimir currently does not support relative paths, so we need to compute the absolute path of `mimir`.
+          echo MAVEN_OPTS="-Dmimir.daemon.passOnBasedir=true -Dmimir.daemon.autostop=true -Dmimir.basedir=$GITHUB_WORKSPACE/.mimir" >> $GITHUB_ENV
+
+      - name: Set up Mimír cache
+        uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684 # 4.2.3
+        with:
+          # Mimir is a partial mirror of Maven Central.
+          # Therefore, we only need to clean it from time to time to remove old versions.
+          #
+          # However, GitHub caches are immutable, and we need a unique key to update them.
+          # If no cache hit occurs for this key, we fall back to any other cache.
+          key: "${{ env.MIMIR_KEY }}-${{ hashFiles('**/pom.xml') }}"
+          restore-keys: |
+            ${{ env.MIMIR_KEY }}-
+          path: .mimir/local
+
       - name: Export version
         id: version
         shell: bash

.github/workflows/merge-dependabot-reusable.yaml

@@ -78,12 +78,45 @@ jobs:
         with:
           distribution: zulu
           java-version: ${{ inputs.java-version }}
-          cache: maven
           server-id: apache.releases.https
           server-username: NEXUS_USERNAME
           server-password: NEXUS_PASSWORD
           gpg-private-key: ${{ secrets.GPG_SECRET_KEY }}
 
+      #
+      # Sets up Mimír (https://maveniverse.eu/docs/mimir/) to cache artifacts from remote repositories
+      #
+      # Unlike the local Maven repository, Mimír cannot be used to stage locally generated artifacts or snapshots.
+      # Therefore, it can be reused between builds, even on different architectures.
+      # Since the size of the cache increases in time, as we download new dependency versions, we reset the cache
+      # once a month.
+      #
+      # WARNING: Currently it is not possible to reuse GitHub workflow steps, therefore, these two steps must be
+      #          copied to multiple workflows.
+      #          The `build-reusable` workflow uses `actions/cache`,
+      #          while the other workflows only use `actions/cache/restore`
+      #
+      - name: Set up Mimír configuration
+        shell: bash
+        run: |
+          # Compute the key cache
+          echo MIMIR_KEY="mimir-cache-$(date +'%Y-%m')" >> $GITHUB_ENV
+          # Mimir currently does not support relative paths, so we need to compute the absolute path of `mimir`.
+          echo MAVEN_OPTS="-Dmimir.daemon.passOnBasedir=true -Dmimir.daemon.autostop=true -Dmimir.basedir=$GITHUB_WORKSPACE/.mimir" >> $GITHUB_ENV
+
+      - name: Set up Mimír cache
+        uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684 # 4.2.3
+        with:
+          # Mimir is a partial mirror of Maven Central.
+          # Therefore, we only need to clean it from time to time to remove old versions.
+          #
+          # However, GitHub caches are immutable, and we need a unique key to update them.
+          # If no cache hit occurs for this key, we fall back to any other cache.
+          key: "${{ env.MIMIR_KEY }}-${{ hashFiles('**/pom.xml') }}"
+          restore-keys: |
+            ${{ env.MIMIR_KEY }}-
+          path: .mimir/local
+
       - name: Find the release version major
         shell: bash
         run: |

.github/workflows/verify-reproducibility-reusable.yaml

@@ -61,7 +61,40 @@ jobs:
         with:
           distribution: zulu
           java-version: ${{ inputs.java-version }}
-          cache: maven
+
+      #
+      # Sets up Mimír (https://maveniverse.eu/docs/mimir/) to cache artifacts from remote repositories
+      #
+      # Unlike the local Maven repository, Mimír cannot be used to stage locally generated artifacts or snapshots.
+      # Therefore, it can be reused between builds, even on different architectures.
+      # Since the size of the cache increases in time, as we download new dependency versions, we reset the cache
+      # once a month.
+      #
+      # WARNING: Currently it is not possible to reuse GitHub workflow steps, therefore, these two steps must be
+      #          copied to multiple workflows.
+      #          The `build-reusable` workflow uses `actions/cache`,
+      #          while the other workflows only use `actions/cache/restore`
+      #
+      - name: Set up Mimír configuration
+        shell: bash
+        run: |
+          # Compute the key cache
+          echo MIMIR_KEY="mimir-cache-$(date +'%Y-%m')" >> $GITHUB_ENV
+          # Mimir currently does not support relative paths, so we need to compute the absolute path of `mimir`.
+          echo MAVEN_OPTS="-Dmimir.daemon.passOnBasedir=true -Dmimir.daemon.autostop=true -Dmimir.basedir=$GITHUB_WORKSPACE/.mimir" >> $GITHUB_ENV
+
+      - name: Set up Mimír cache
+        uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684 # 4.2.3
+        with:
+          # Mimir is a partial mirror of Maven Central.
+          # Therefore, we only need to clean it from time to time to remove old versions.
+          #
+          # However, GitHub caches are immutable, and we need a unique key to update them.
+          # If no cache hit occurs for this key, we fall back to any other cache.
+          key: "${{ env.MIMIR_KEY }}-${{ hashFiles('**/pom.xml') }}"
+          restore-keys: |
+            ${{ env.MIMIR_KEY }}-
+          path: .mimir/local
 
       # `clean verify artifact:compare` is required to generate the build reproducibility report.
       # For details, see: https://maven.apache.org/guides/mini/guide-reproducible-builds.html#how-to-test-my-maven-build-reproducibility

.gitignore

@@ -16,6 +16,7 @@
 # Maven
 target/
 .flattened-pom.xml
+/.mimir/
 /.mvn/extensions.xml
 /.mvn/wrapper/maven-wrapper.jar
 # IDEA

pom.xml

@@ -227,6 +227,7 @@
     <jacoco-maven-plugin.version>0.8.13</jacoco-maven-plugin.version>
     <log4j-changelog-maven-plugin.version>0.9.0</log4j-changelog-maven-plugin.version>
     <maven-artifact-plugin.version>3.6.0</maven-artifact-plugin.version>
+    <mimir.version>0.7.4</mimir.version>
     <restrict-imports-enforcer-rule.version>2.6.1</restrict-imports-enforcer-rule.version>
     <spotbugs-maven-plugin.version>4.9.3.0</spotbugs-maven-plugin.version>
     <spotless-maven-plugin.version>2.44.4</spotless-maven-plugin.version>
@@ -362,6 +363,12 @@
           <version>${maven-artifact-plugin.version}</version>
         </plugin>
 
+        <plugin>
+          <groupId>eu.maveniverse.maven.mimir</groupId>
+          <artifactId>extension</artifactId>
+          <version>${mimir.version}</version>
+        </plugin>
+
         <plugin>
           <groupId>com.github.spotbugs</groupId>
           <artifactId>spotbugs-maven-plugin</artifactId>
@@ -956,6 +963,16 @@
         </executions>
       </plugin>
 
+      <!--
+        ~ Use Mimir as Maven cache:
+        ~ See: https://maveniverse.eu/docs/mimir/
+        -->
+      <plugin>
+        <groupId>eu.maveniverse.maven.mimir</groupId>
+        <artifactId>extension</artifactId>
+        <extensions>true</extensions>
+      </plugin>
+
     </plugins>
 
   </build>

src/changelog/.12.x.x/add-mimir.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns="https://logging.apache.org/xml/ns"
+       xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+       type="added">
+  <issue id="389" link="https://github.com/apache/logging-parent/pull/389"/>
+  <description format="asciidoc">Use Mimír instead of Maven local repository cache.</description>
+</entry>