https://github.com/jabref/jabref-action
BibTeX GitHub Action
https://github.com/jabref/jabref-action
bbitex biblatex github-action jabref
Last synced: 4 months ago
JSON representation
BibTeX GitHub Action
- Host: GitHub
- URL: https://github.com/jabref/jabref-action
- Owner: JabRef
- License: mit
- Created: 2025-04-27T19:23:58.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-05-15T22:23:30.000Z (5 months ago)
- Last Synced: 2025-05-15T22:38:08.792Z (5 months ago)
- Topics: bbitex, biblatex, github-action, jabref
- Language: TeX
- Homepage:
- Size: 539 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# JabRef Action
> BibTeX GitHub Action
Currently executing JabRef's consistency check.
## Example use
Checking [Chocolate.bib](https://github.com/JabRef/jabref-demo-libraries/blob/97faf2b6ed94fc15c4f6e5645da3a69796d8f6d3/chocolate/Chocolate.bib#L1):
```yaml
name: Check
on:
pull_request:
jobs:
test-action:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run jabref-action
uses: jabref/jabref-action@main
with:
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
```
## Development
This action uses JabRef's jabkit Dockerimage. Contribute to jabkit at [jabkit](https://github.com/JabRef/jabref/tree/main/jabkit).