From f9ef16ecdef872bde7cda18c4deebd851d859fd0 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 5 Jul 2025 09:54:14 +0200 Subject: [PATCH 1/5] Add check for chocolate.bib --- .github/workflows/check.yml | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 37432af..2faf5ec 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -13,6 +13,10 @@ jobs: packages: read steps: - uses: actions/checkout@v4 + - uses: actions/checkout@v4 + with: + repository: https://github.com/JabRef/jabref-demonstration-libraries.git + path: jabref-demonstration-libraries - name: Log in to GitHub Container Registry uses: docker/login-action@v3 with: @@ -29,6 +33,15 @@ jobs: id: inconsistent with: bibfile: test/inconsistent.bib - - name: inconsistent failed? + - name: inconsistent did not fail? if: steps.inconsistent.outcome == 'success' run: exit 1 + - name: Check jabref-demonstration-libraries/chocolate/Chocolate.bib + continue-on-error: true + uses: ./ + id: chocolate + with: + bibfile: test/inconsistent.bib + - name: chocolate did not fail? + if: steps.chocolate.outcome == 'success' + run: exit 1 From 75cf002020d9b815c3e53f626c2a26695c31bed5 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 5 Jul 2025 09:57:14 +0200 Subject: [PATCH 2/5] Fix format --- .github/workflows/check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 2faf5ec..6cedd3a 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -15,7 +15,7 @@ jobs: - uses: actions/checkout@v4 - uses: actions/checkout@v4 with: - repository: https://github.com/JabRef/jabref-demonstration-libraries.git + repository: JabRef/jabref-demonstration-libraries path: jabref-demonstration-libraries - name: Log in to GitHub Container Registry uses: docker/login-action@v3 From 5610a65098f2790a2944aec809591541485f28a1 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 5 Jul 2025 10:13:51 +0200 Subject: [PATCH 3/5] Fix path --- .github/workflows/check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 6cedd3a..9c34e00 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -41,7 +41,7 @@ jobs: uses: ./ id: chocolate with: - bibfile: test/inconsistent.bib + bibfile: jabref-demonstration-libraries/chocolate/Chocolate.bib - name: chocolate did not fail? if: steps.chocolate.outcome == 'success' run: exit 1 From 6fe9999f016db497f6e9784d293e62bf2adfd8e7 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 5 Jul 2025 10:26:19 +0200 Subject: [PATCH 4/5] Pin chocolate.bib --- .github/workflows/check.yml | 13 ++++--- .vscode/ltex.dictionary.en-US.txt | 1 + README.md | 59 +++++++++++++++---------------- 3 files changed, 37 insertions(+), 36 deletions(-) create mode 100644 .vscode/ltex.dictionary.en-US.txt diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 9c34e00..25d1868 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -12,17 +12,14 @@ jobs: permissions: packages: read steps: - - uses: actions/checkout@v4 - - uses: actions/checkout@v4 - with: - repository: JabRef/jabref-demonstration-libraries - path: jabref-demonstration-libraries - name: Log in to GitHub Container Registry uses: docker/login-action@v3 with: registry: ghcr.io username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} + + - uses: actions/checkout@v4 - name: Check test/consistent.bib uses: ./ with: @@ -36,6 +33,12 @@ jobs: - name: inconsistent did not fail? if: steps.inconsistent.outcome == 'success' run: exit 1 + + - uses: actions/checkout@v4 + with: + repository: JabRef/jabref-demonstration-libraries + path: jabref-demonstration-libraries + ref: 97faf2b6 - name: Check jabref-demonstration-libraries/chocolate/Chocolate.bib continue-on-error: true uses: ./ diff --git a/.vscode/ltex.dictionary.en-US.txt b/.vscode/ltex.dictionary.en-US.txt new file mode 100644 index 0000000..d2d6666 --- /dev/null +++ b/.vscode/ltex.dictionary.en-US.txt @@ -0,0 +1 @@ +JabRef diff --git a/README.md b/README.md index 76a8028..892bc01 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ Currently executing JabRef's consistency check. -## Example use +## Example Use -Checking [Chocolate.bib](https://github.com/JabRef/jabref-demo-libraries/blob/97faf2b6ed94fc15c4f6e5645da3a69796d8f6d3/chocolate/Chocolate.bib#L1): +Checking [Chocolate.bib#97faf2b6](https://github.com/JabRef/jabref-demo-libraries/blob/97faf2b6ed94fc15c4f6e5645da3a69796d8f6d3/chocolate/Chocolate.bib#L1): ```yaml name: Check @@ -27,35 +27,32 @@ jobs: bibfile: Chocolate.bib ``` -Output: - -```markdown -Field Presence Consistency Check Result - -| entry type | citation key | Eprint | Groups | Number | Pages | Readstatus | URL | -| ---------- | ------------ | ------ | ------ | ------ | ----- | ---------- | --- | -| Article | Garcia_2018 | - | - | o | - | - | - | -| Article | Ding_2006 | - | - | o | - | - | - | -| Article | Richard_2017 | - | ? | - | - | ? | - | -| Article | Corti_2009 | - | - | o | o | - | - | -| Article | Cooper_2007 | - | - | o | o | - | - | -| Article | Tokede_2011 | - | - | o | o | - | - | -| Article | Keen_2001 | - | - | o | o | - | - | -| Article | Katz_2011 | - | - | o | o | ? | - | -| Article | Hooper_2012 | - | - | o | o | ? | - | -| Article | Tan_2021 | - | - | o | o | ? | - | -| Article | Fulton_1969 | o | - | o | o | - | o | -| Article | Parker_2006 | - | ? | o | o | ? | - | -| Article | Macht_2007 | - | ? | o | o | ? | - | -| Article | Scholey_2013 | - | ? | o | o | ? | - | -| Article | Di_Renzo_2012 | - | ? | o | o | ? | - | - -x | required field is present -o | optional field is present -? | unknown field is present -- | field is absent -Consistency check completed -``` +### Output + +| entry type | citation key | Eprint | File | Number | Pages | URL | +| ---------- | -------------- | ------ | ---- | ------ | ----- | --- | +| Article | Cooper_2007 | - | - | o | o | - | +| Article | Corti_2009 | - | - | o | o | - | +| Article | Di_Renzo_2012 | - | - | o | o | - | +| Article | Ding_2006 | - | - | o | - | - | +| Article | Fulton_1969 | o | - | o | o | o | +| Article | Garcia_2018 | - | - | o | - | - | +| Article | Hooper_2012 | - | - | o | o | - | +| Article | Katz_2011 | - | - | o | o | - | +| Article | Keen_2001 | - | - | o | o | - | +| Article | LunaOstos_2024 | - | ? | o | o | - | +| Article | Macht_2007 | - | - | o | o | - | +| Article | Parker_2006 | - | - | o | o | - | +| Article | Scholey_2013 | - | - | o | o | - | +| Article | Tan_2021 | - | - | o | o | - | +| Article | Tokede_2011 | - | - | o | o | - | + +| Symbol | Meaning | +| ------ | ------------------------- | +| x | required field is present | +| o | optional field is present | +| ? | unknown field is present | +| - | field is absent | ## Development From 29c49fea1f10351bc3271100428280c3ad2f2ade Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Sat, 5 Jul 2025 10:28:17 +0200 Subject: [PATCH 5/5] More digits for sha value --- .github/workflows/check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 25d1868..c7a6ebf 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -38,7 +38,7 @@ jobs: with: repository: JabRef/jabref-demonstration-libraries path: jabref-demonstration-libraries - ref: 97faf2b6 + ref: 97faf2b6ed94fc15c4f6e5645da3a69796d8f6d3 - name: Check jabref-demonstration-libraries/chocolate/Chocolate.bib continue-on-error: true uses: ./