GH workflow: For forks pull_requests use base Maven repo (#5)

Author: jann0k

.github/workflows/maven.yml

@@ -18,9 +18,22 @@ env:
   ACTIONS_STEP_DEBUG: true
 
 jobs:
-  build:
+  fork_setup:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == true }}
+    outputs:
+      base_repo: ${{ steps.base_repo.outputs.name }}
+      is_fork: ${{ steps.is_fork.outputs.is_fork }}
+
+    steps:
+      - id: base_repo
+        run: echo "name=${{github.event.pull_request.base.repo.full_name}}" >> "$GITHUB_OUTPUT"
+      - id: is_fork
+        run: echo "is_fork=true" >> "$GITHUB_OUTPUT"
 
+  build:
     runs-on: ubuntu-latest
+    needs: fork_setup
 
     steps:
     - uses: actions/checkout@v4
@@ -34,9 +47,16 @@ jobs:
         cache: maven
 
     - name: Build with Maven
-      run: mvn -B package --file pom.xml
+      run: | 
+        echo "Debug env vars: is_fork=$IS_FORK base_repo=$BASE_REPO MAVEN_REPO=$MAVEN_REPO"
+        mvn help:active-profiles
+        echo "Using Maven repo=$(mvn help:evaluate -Dexpression=github_ci.maven_repo -q -DforceStdout)"
+        mvn -B package --file pom.xml
       env:
         GITHUB_TOKEN: ${{ github.token }} # GITHUB_TOKEN is the default env for the password
+        IS_FORK: ${{needs.fork_setup.outputs.is_fork}}
+        BASE_REPO: ${{needs.fork_setup.outputs.base_repo}}
+
 
 
     # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive

README.md

@@ -160,7 +160,6 @@ Other CDOC2 repositories:
 ## Preconditions for building
 * Java 17
 * Maven 3.8.x
-* Docker available and running (required for running tests, use `-Dmaven.test.skip=true` to skip)
 
 ## Maven dependencies
 
@@ -202,8 +201,18 @@ CDOC2 has been tested with JDK 17 and Maven 3.8.8
 mvn clean install
 ```
 
+### GitHub workflow build
+
+Maven build is executed for GH event `pull_request` an and `push` to 'master'. 
+
+GH build workflow configures Maven repository automatically. For fork based pull_requests 
+Maven repo value will be set to `github.event.pull_request.base.repo.full_name`. It can be overwritten
+by [defining repository variable](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/variables#creating-configuration-variables-for-a-repository) 
+`MAVEN_REPO`
+
+
 ## Testing
-By default tests that require smart-card are excluded from running. To execute all tests enable allTests maven profile
+By default, tests that require smart-card are excluded from running. To execute all tests enable allTests maven profile
 ```
 mvn -PallTests test
 ```

pom.xml

@@ -85,6 +85,49 @@
             </build>
         </profile>
 
+        <profile>
+            <id>github_ci_fork</id>
+            <!-- for forks use base maven repo "open-eid/cdoc2-java-ref-impl" -->
+            <activation>
+                <property>
+                    <!-- defined by maven.yml for forks only -->
+                    <name>env.BASE_REPO</name>
+                </property>
+            </activation>
+            <properties>
+                <github_ci.maven_repo>https://maven.pkg.github.com/${env.BASE_REPO}</github_ci.maven_repo>
+            </properties>
+        </profile>
+
+        <profile>
+            <id>github_ci_not_fork_or_not_pull_request</id>
+            <activation>
+                <property>
+                    <!-- set by maven.yml for forks only -->
+                    <name>env.IS_FORK</name>
+                    <!-- "is_fork" is not defined, or is defined with a value which is not "true". -->
+                    <value>!true</value>
+                </property>
+            </activation>
+            <properties>
+                <!--suppress UnresolvedMavenProperty -->
+                <github_ci.maven_repo>https://maven.pkg.github.com/${env.GITHUB_REPOSITORY}</github_ci.maven_repo>
+            </properties>
+        </profile>
+
+        <profile>
+            <id>overwrite "github_ci.maven_repo" from env var "MAVEN_REPO"</id>
+            <activation>
+                <property>
+                    <name>env.MAVEN_REPO</name>
+                </property>
+            </activation>
+            <properties>
+                <github_ci.maven_repo>https://maven.pkg.github.com/${env.MAVEN_REPO}</github_ci.maven_repo>
+            </properties>
+        </profile>
+
+
         <profile>
             <!-- activate github profile when run by github actions -->
             <id>github_ci</id>
@@ -103,7 +146,7 @@
                     <!-- Although GITHUB_REPOSITORY contains repo, all organization packages are indexed there -->
                     <!-- https://stackoverflow.com/questions/63041402/github-packages-single-maven-repository-for-github-organization -->
                     <!--suppress UnresolvedMavenProperty -->
-                    <url>https://maven.pkg.github.com/${env.GITHUB_REPOSITORY}</url>
+                    <url>${github_ci.maven_repo}</url>
                 </repository>
 
             </repositories>