Skip to content

Commit 18b822b

Browse files
authored
Add check for chocolate.bib (#6)
1 parent d553182 commit 18b822b

3 files changed

Lines changed: 47 additions & 33 deletions

File tree

.github/workflows/check.yml

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@ jobs:
1212
permissions:
1313
packages: read
1414
steps:
15-
- uses: actions/checkout@v4
1615
- name: Log in to GitHub Container Registry
1716
uses: docker/login-action@v3
1817
with:
1918
registry: ghcr.io
2019
username: ${{ github.actor }}
2120
password: ${{ secrets.GITHUB_TOKEN }}
21+
22+
- uses: actions/checkout@v4
2223
- name: Check test/consistent.bib
2324
uses: ./
2425
with:
@@ -29,6 +30,21 @@ jobs:
2930
id: inconsistent
3031
with:
3132
bibfile: test/inconsistent.bib
32-
- name: inconsistent failed?
33+
- name: inconsistent did not fail?
3334
if: steps.inconsistent.outcome == 'success'
3435
run: exit 1
36+
37+
- uses: actions/checkout@v4
38+
with:
39+
repository: JabRef/jabref-demonstration-libraries
40+
path: jabref-demonstration-libraries
41+
ref: 97faf2b6ed94fc15c4f6e5645da3a69796d8f6d3
42+
- name: Check jabref-demonstration-libraries/chocolate/Chocolate.bib
43+
continue-on-error: true
44+
uses: ./
45+
id: chocolate
46+
with:
47+
bibfile: jabref-demonstration-libraries/chocolate/Chocolate.bib
48+
- name: chocolate did not fail?
49+
if: steps.chocolate.outcome == 'success'
50+
run: exit 1

.vscode/ltex.dictionary.en-US.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
JabRef

README.md

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
55
Currently executing JabRef's consistency check.
66

7-
## Example use
7+
## Example Use
88

9-
Checking [Chocolate.bib](https://github.com/JabRef/jabref-demo-libraries/blob/97faf2b6ed94fc15c4f6e5645da3a69796d8f6d3/chocolate/Chocolate.bib#L1):
9+
Checking [Chocolate.bib#97faf2b6](https://github.com/JabRef/jabref-demo-libraries/blob/97faf2b6ed94fc15c4f6e5645da3a69796d8f6d3/chocolate/Chocolate.bib#L1):
1010

1111
```yaml
1212
name: Check
@@ -27,35 +27,32 @@ jobs:
2727
bibfile: Chocolate.bib
2828
```
2929
30-
Output:
31-
32-
```markdown
33-
Field Presence Consistency Check Result
34-
35-
| entry type | citation key | Eprint | Groups | Number | Pages | Readstatus | URL |
36-
| ---------- | ------------ | ------ | ------ | ------ | ----- | ---------- | --- |
37-
| Article | Garcia_2018 | - | - | o | - | - | - |
38-
| Article | Ding_2006 | - | - | o | - | - | - |
39-
| Article | Richard_2017 | - | ? | - | - | ? | - |
40-
| Article | Corti_2009 | - | - | o | o | - | - |
41-
| Article | Cooper_2007 | - | - | o | o | - | - |
42-
| Article | Tokede_2011 | - | - | o | o | - | - |
43-
| Article | Keen_2001 | - | - | o | o | - | - |
44-
| Article | Katz_2011 | - | - | o | o | ? | - |
45-
| Article | Hooper_2012 | - | - | o | o | ? | - |
46-
| Article | Tan_2021 | - | - | o | o | ? | - |
47-
| Article | Fulton_1969 | o | - | o | o | - | o |
48-
| Article | Parker_2006 | - | ? | o | o | ? | - |
49-
| Article | Macht_2007 | - | ? | o | o | ? | - |
50-
| Article | Scholey_2013 | - | ? | o | o | ? | - |
51-
| Article | Di_Renzo_2012 | - | ? | o | o | ? | - |
52-
53-
x | required field is present
54-
o | optional field is present
55-
? | unknown field is present
56-
- | field is absent
57-
Consistency check completed
58-
```
30+
### Output
31+
32+
| entry type | citation key | Eprint | File | Number | Pages | URL |
33+
| ---------- | -------------- | ------ | ---- | ------ | ----- | --- |
34+
| Article | Cooper_2007 | - | - | o | o | - |
35+
| Article | Corti_2009 | - | - | o | o | - |
36+
| Article | Di_Renzo_2012 | - | - | o | o | - |
37+
| Article | Ding_2006 | - | - | o | - | - |
38+
| Article | Fulton_1969 | o | - | o | o | o |
39+
| Article | Garcia_2018 | - | - | o | - | - |
40+
| Article | Hooper_2012 | - | - | o | o | - |
41+
| Article | Katz_2011 | - | - | o | o | - |
42+
| Article | Keen_2001 | - | - | o | o | - |
43+
| Article | LunaOstos_2024 | - | ? | o | o | - |
44+
| Article | Macht_2007 | - | - | o | o | - |
45+
| Article | Parker_2006 | - | - | o | o | - |
46+
| Article | Scholey_2013 | - | - | o | o | - |
47+
| Article | Tan_2021 | - | - | o | o | - |
48+
| Article | Tokede_2011 | - | - | o | o | - |
49+
50+
| Symbol | Meaning |
51+
| ------ | ------------------------- |
52+
| x | required field is present |
53+
| o | optional field is present |
54+
| ? | unknown field is present |
55+
| - | field is absent |
5956
6057
6158
## Development

0 commit comments

Comments
 (0)