From ff7f6ac13e3f56567bbd80cafe8702a3eb0c32ba Mon Sep 17 00:00:00 2001 From: evealitaylor Date: Fri, 17 Oct 2025 10:59:25 +1100 Subject: [PATCH 01/16] Creating new entrypoint using step summary --- entrypoint.sh | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 entrypoint.sh diff --git a/entrypoint.sh b/entrypoint.sh new file mode 100644 index 0000000..16a31a9 --- /dev/null +++ b/entrypoint.sh @@ -0,0 +1,3 @@ +#!/bin/sh -l + +/jabref/jabkit/bin/jabkit "$@" >> $GITHUB_STEP_SUMMARY From 87a5c14ec42aad919d31c2a16d0453f467a63c2b Mon Sep 17 00:00:00 2001 From: evealitaylor Date: Fri, 17 Oct 2025 10:59:25 +1100 Subject: [PATCH 02/16] feat(JabRef#8):Creating new entrypoint using step summary --- entrypoint.sh | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 entrypoint.sh diff --git a/entrypoint.sh b/entrypoint.sh new file mode 100644 index 0000000..16a31a9 --- /dev/null +++ b/entrypoint.sh @@ -0,0 +1,3 @@ +#!/bin/sh -l + +/jabref/jabkit/bin/jabkit "$@" >> $GITHUB_STEP_SUMMARY From 9c0cfc268e9dc78e6b8be07a42cc93c4066c98a1 Mon Sep 17 00:00:00 2001 From: evealitaylor Date: Fri, 17 Oct 2025 11:09:41 +1100 Subject: [PATCH 03/16] feat(JabRef#8):Configuring Dockerfile to use new entrypoint --- Dockerfile | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index 213e642..78152a3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,6 @@ -// Corresponding Dockerfile: https://github.com/JabRef/jabref/blob/main/Dockerfile.jabkit FROM ghcr.io/jabref/jabkit:edge -ENTRYPOINT ["/jabref/jabkit/bin/jabkit"] +COPY entrypoint.sh /entrypoint.sh +RUN chmod +x /entrypoint.sh + +ENTRYPOINT ["/entrypoint.sh"] From f16de5d6ed8ee0f773c6b77152e9eddff01e1762 Mon Sep 17 00:00:00 2001 From: evealitaylor Date: Fri, 17 Oct 2025 11:11:16 +1100 Subject: [PATCH 04/16] docs(JabRef#8):Additional documentation explaining step summary output --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 77ddb20..3c628cb 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,8 @@ jobs: ### Output +The action generates a consistency check report as a Markdown table. This is automatically added to the Job Summary of your workflow run. + | entry type | citation key | Eprint | File | Number | Pages | URL | | ---------- | -------------- | ------ | ---- | ------ | ----- | --- | | Article | Cooper_2007 | - | - | o | o | - | From 621100804d63d12e345a22af611c3afbc8f27b33 Mon Sep 17 00:00:00 2001 From: evealitaylor Date: Sat, 18 Oct 2025 13:23:13 +1100 Subject: [PATCH 05/16] feat(JabRef#8):Adjusted dockerfile to retain corresponding dockerfile and remove chmod --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 78152a3..037f838 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,6 @@ +// Corresponding Dockerfile: https://github.com/JabRef/jabref/blob/main/Dockerfile.jabkit FROM ghcr.io/jabref/jabkit:edge COPY entrypoint.sh /entrypoint.sh -RUN chmod +x /entrypoint.sh ENTRYPOINT ["/entrypoint.sh"] From 5196ee1172b44c438675d18093fcdec555a630a1 Mon Sep 17 00:00:00 2001 From: evealitaylor Date: Sat, 18 Oct 2025 13:24:30 +1100 Subject: [PATCH 06/16] feat(JabRef#8):Adding reference to porcelain in entrypoint --- entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index 16a31a9..dba0f11 100644 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -1,3 +1,3 @@ #!/bin/sh -l -/jabref/jabkit/bin/jabkit "$@" >> $GITHUB_STEP_SUMMARY +/jabref/jabkit/bin/jabkit check-consistency "$@" --porcelain >> $GITHUB_STEP_SUMMARY From 85f7aeb7202b04de1e4ed71273e10af6f6b0fc3c Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 25 Oct 2025 15:17:31 +0200 Subject: [PATCH 07/16] Fix execution flag for entrypoint.sh --- entrypoint.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 entrypoint.sh diff --git a/entrypoint.sh b/entrypoint.sh old mode 100644 new mode 100755 From b14812e8e20bdccb87875423535507127d3eb6f8 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 25 Oct 2025 15:19:29 +0200 Subject: [PATCH 08/16] Fix comment char --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 037f838..88137f3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -// Corresponding Dockerfile: https://github.com/JabRef/jabref/blob/main/Dockerfile.jabkit +# Corresponding Dockerfile: https://github.com/JabRef/jabref/blob/main/Dockerfile.jabkit FROM ghcr.io/jabref/jabkit:edge COPY entrypoint.sh /entrypoint.sh From d6e7e265ed931ed888ff06a1fd8b62eb78d4eee9 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 25 Oct 2025 15:22:07 +0200 Subject: [PATCH 09/16] Fix double porcelain --- entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index dba0f11..358c6de 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -1,3 +1,3 @@ #!/bin/sh -l -/jabref/jabkit/bin/jabkit check-consistency "$@" --porcelain >> $GITHUB_STEP_SUMMARY +/jabref/jabkit/bin/jabkit check-consistency "$@" >> $GITHUB_STEP_SUMMARY From 6eae73581c463b7b5584db864b97830addd09989 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 25 Oct 2025 15:29:59 +0200 Subject: [PATCH 10/16] Fix double check-consistency --- entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index 358c6de..16a31a9 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -1,3 +1,3 @@ #!/bin/sh -l -/jabref/jabkit/bin/jabkit check-consistency "$@" >> $GITHUB_STEP_SUMMARY +/jabref/jabkit/bin/jabkit "$@" >> $GITHUB_STEP_SUMMARY From a842642d1ec61ad13afa3082a1fc5cd2b44df259 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 25 Oct 2025 15:51:24 +0200 Subject: [PATCH 11/16] Use tee --- entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index 16a31a9..48a91e5 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -1,3 +1,3 @@ #!/bin/sh -l -/jabref/jabkit/bin/jabkit "$@" >> $GITHUB_STEP_SUMMARY +/jabref/jabkit/bin/jabkit "$@" | tee $GITHUB_STEP_SUMMARY From d997dc40e8ee4b39c742077d5d2f6c683dba45ef Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 25 Oct 2025 15:54:52 +0200 Subject: [PATCH 12/16] Have the action failing --- entrypoint.sh | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/entrypoint.sh b/entrypoint.sh index 48a91e5..a6a318b 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -1,3 +1,4 @@ -#!/bin/sh -l - -/jabref/jabkit/bin/jabkit "$@" | tee $GITHUB_STEP_SUMMARY +#!/usr/bin/env bash +set -o pipefail +/jabref/jabkit/bin/jabkit "$@" 2>&1 | tee -a "$GITHUB_STEP_SUMMARY" +exit ${PIPESTATUS[0]} From 1ba447fe684819e59ecb18199e2ab2a5dcd300b8 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 25 Oct 2025 15:59:28 +0200 Subject: [PATCH 13/16] Add library as heading --- action.yml | 1 + entrypoint.sh | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/action.yml b/action.yml index 7f62abe..23119f6 100644 --- a/action.yml +++ b/action.yml @@ -9,6 +9,7 @@ runs: using: 'docker' image: 'Dockerfile' args: + - ${{ inputs.bibfile }} - check-consistency - --input=${{ inputs.bibfile }} - --porcelain diff --git a/entrypoint.sh b/entrypoint.sh index a6a318b..c36ef2d 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -1,4 +1,10 @@ #!/usr/bin/env bash set -o pipefail + +echo "# $1" >> $GITHUB_STEP_SUMMARY +echo "" >> $GITHUB_STEP_SUMMARY + +shift + /jabref/jabkit/bin/jabkit "$@" 2>&1 | tee -a "$GITHUB_STEP_SUMMARY" exit ${PIPESTATUS[0]} From 46dc26a13cf38415924f4b3cfcdcbe963c2bb995 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 25 Oct 2025 16:01:33 +0200 Subject: [PATCH 14/16] Output if no inconsistencies --- entrypoint.sh | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index c36ef2d..d008629 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -7,4 +7,11 @@ echo "" >> $GITHUB_STEP_SUMMARY shift /jabref/jabkit/bin/jabkit "$@" 2>&1 | tee -a "$GITHUB_STEP_SUMMARY" -exit ${PIPESTATUS[0]} + +exit_code=${PIPESTATUS[0]} + +if [ "$exit_code" -eq 0 ]; then + echo "✅ no inconsistencies" | tee -a "$GITHUB_STEP_SUMMARY" +fi + +exit "$exit_code" From 44d2ff753c531aa62b77b367d83b1bbc3f51db96 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 25 Oct 2025 16:02:41 +0200 Subject: [PATCH 15/16] Smaller headings --- entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index d008629..35904cb 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash set -o pipefail -echo "# $1" >> $GITHUB_STEP_SUMMARY +echo "## $1" >> $GITHUB_STEP_SUMMARY echo "" >> $GITHUB_STEP_SUMMARY shift From 411b519617c46031741c977f08c09d78482ea28f Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 25 Oct 2025 16:06:23 +0200 Subject: [PATCH 16/16] Update README to specify job summary link --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c628cb..67a2c4b 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,8 @@ jobs: ### Output -The action generates a consistency check report as a Markdown table. This is automatically added to the Job Summary of your workflow run. +The action generates a consistency check report as a Markdown table. +This is automatically added to the [Job summary](https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#example-of-adding-a-job-summary) of your workflow run. | entry type | citation key | Eprint | File | Number | Pages | URL | | ---------- | -------------- | ------ | ---- | ------ | ----- | --- |