Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,14 @@ jobs:
permissions:
packages: read
steps:
- uses: actions/checkout@v4
- 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:
Expand All @@ -29,6 +30,21 @@ jobs:
id: inconsistent
with:
bibfile: test/inconsistent.bib
- name: inconsistent failed?
- 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: 97faf2b6ed94fc15c4f6e5645da3a69796d8f6d3
- name: Check jabref-demonstration-libraries/chocolate/Chocolate.bib
continue-on-error: true
uses: ./
id: chocolate
with:
bibfile: jabref-demonstration-libraries/chocolate/Chocolate.bib
- name: chocolate did not fail?
if: steps.chocolate.outcome == 'success'
run: exit 1
1 change: 1 addition & 0 deletions .vscode/ltex.dictionary.en-US.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
JabRef
59 changes: 28 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down