Skip to content

Commit df1d3a7

Browse files
ceberamceberam
authored
chore: add project configuration files (#1)
Signed-off-by: Cesar Berrospi Ramis <[email protected]>
1 parent 09b158a commit df1d3a7

15 files changed

+1040
-1
lines changed

‎.bumpversion.toml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[tool.bumpversion]
2+
current_version = "0.1.0"
3+
parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
4+
serialize = ["{major}.{minor}.{patch}"]
5+
search = "{current_version}"
6+
replace = "{new_version}"
7+
regex = false
8+
ignore_missing_version = false
9+
tag = false
10+
sign_tags = false
11+
tag_name = "v{new_version}"
12+
tag_message = "Update version {current_version} → {new_version}"
13+
allow_dirty = false
14+
commit = true
15+
message = "build: update version {current_version} → {new_version}"
16+
commit_args = ""
17+
18+
[[tool.bumpversion.files]]
19+
filename = "README.md"
20+
search = "{current_version}"
21+
replace = "{new_version}"

‎.github/PULL_REQUEST_TEMPLATE.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Thank you for contributing to Docling! -->
2+
3+
<!-- STEPS TO FOLLOW:
4+
1. Add a description of the changes (frequently the same as the commit description)
5+
2. Enter the issue number next to "Resolves #" below (if there is no tracking issue resolved, **remove that section**)
6+
3. Make sure the PR title follows the **Commit Message Formatting**: https://www.conventionalcommits.org/en/v1.0.0/#summary.
7+
-->
8+
9+
<!-- Uncomment this section with the issue number if an issue is being resolved
10+
**Issue resolved by this Pull Request:**
11+
Resolves #
12+
--->
13+

‎.github/SECURITY.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Security and Disclosure Information Policy for the Docling Project
2+
3+
The Docling team and community take security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
4+
5+
## Reporting a Vulnerability
6+
7+
If you think you've identified a security issue in a Docling project repository, please DO NOT report the issue publicly via the GitHub issue tracker, etc.
8+
9+
Instead, send an email with as many details as possible to [[email protected]](mailto:[email protected]). This is a private mailing list for the maintainers team.
10+
11+
Please do not create a public issue.
12+
13+
## Security Vulnerability Response
14+
15+
Each report is acknowledged and analyzed by the core maintainers within 3 working days.
16+
17+
Any vulnerability information shared with core maintainers stays within the Docling project and will not be disseminated to other projects unless it is necessary to get the issue fixed.
18+
19+
After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
20+
21+
## Security Alerts
22+
23+
We will send announcements of security vulnerabilities and steps to remediate on the [Docling announcements](https://github.com/docling-project/docling/discussions/categories/announcements).

‎.github/mergify.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
merge_protections:
2+
- name: Enforce conventional commit
3+
description: Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
4+
if:
5+
- base = main
6+
success_conditions:
7+
- "title ~=
8+
^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\\(.+\
9+
\\))?(!)?:"

‎.github/workflows/build.yaml

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# This workflow will build and unit test the project.
2+
# If the workflow is running on the "main" branch, then
3+
# semantic-release is also run to create a new release (if
4+
# warranted by the new commits being built).
5+
6+
name: Build/Release
7+
8+
on:
9+
push:
10+
branches:
11+
- main
12+
13+
permissions:
14+
contents: read # for checkout
15+
16+
jobs:
17+
build:
18+
name: Build/Test (Java ${{matrix.java-version}})
19+
runs-on: ubuntu-latest
20+
strategy:
21+
matrix:
22+
java-version: ['11', '17', '21', '24']
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v4
26+
- name: Setup Java ${{matrix.java-version}}
27+
uses: actions/setup-java@v4
28+
with:
29+
java-version: ${{matrix.java-version}}
30+
distribution: 'adopt'
31+
cache: 'maven'
32+
- name: Build & Test
33+
run: mvn -B clean package
34+
35+
create-release:
36+
needs: build
37+
name: Semantic-Release
38+
if: "github.ref_name == 'main' && github.event_name != 'pull_request'"
39+
runs-on: ubuntu-latest
40+
permissions:
41+
contents: write # to be able to publish a GitHub release
42+
issues: write # to be able to comment on released issues
43+
pull-requests: write # to be able to comment on released pull requests
44+
id-token: write # to enable use of OIDC for npm provenance
45+
steps:
46+
- name: Checkout repository
47+
uses: actions/checkout@v4
48+
with:
49+
persist-credentials: false
50+
- name: Setup Node.js
51+
uses: actions/setup-node@v4
52+
with:
53+
node-version: "lts/*"
54+
- name: Install dependencies
55+
run: npm clean-install
56+
- name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
57+
run: npm audit signatures
58+
- name: Release
59+
env:
60+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
61+
run: npm run semantic-release

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -263,3 +263,5 @@ $RECYCLE.BIN/
263263

264264
# End of https://www.toptal.com/developers/gitignore/api/maven,macos,emacs,windows,eclipse,visualstudiocode,vim,java
265265

266+
# Visual Studio Code
267+
.vscode/

‎.releaserc

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"debug": true,
3+
"tagFormat": "${version}",
4+
"branches": [ "main" ],
5+
"plugins": [
6+
"@semantic-release/commit-analyzer",
7+
"@semantic-release/release-notes-generator",
8+
"@semantic-release/changelog",
9+
[
10+
"@semantic-release/exec",
11+
{
12+
"prepareCmd": "bump-my-version bump --allow-dirty --current-version ${lastRelease.version} --new-version ${nextRelease.version}"
13+
}
14+
],
15+
[
16+
"@semantic-release/git",
17+
{
18+
"assets" : [ "pom.xml", "CHANGELOG.md" ],
19+
"message": "chore(release): bump ${nextRelease.version}\n\n${nextRelease.notes}"
20+
}
21+
],
22+
"@semantic-release/github"
23+
]
24+
}

‎CITATION.cff

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# This CITATION.cff file was generated with cffinit.
2+
# Visit https://bit.ly/cffinit to generate yours today!
3+
4+
cff-version: 1.2.0
5+
title: Docling
6+
message: 'If you use Docling, please consider citing as below.'
7+
type: software
8+
authors:
9+
- name: Docling Team
10+
identifiers:
11+
- type: url
12+
value: 'https://arxiv.org/abs/2408.09869'
13+
description: 'arXiv:2408.09869'
14+
repository-code: 'https://github.com/DS4SD/docling'
15+
license: MIT

‎CODE_OF_CONDUCT.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
This project adheres to the [Docling - Code of Conduct and Covenant](https://github.com/docling-project/community/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

‎README.md

+65-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,65 @@
1-
# docling4j
1+
[![License MIT](https://img.shields.io/github/license/docling-project/docling-parse)](https://opensource.org/licenses/MIT)
2+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
3+
4+
5+
# Docling4j version 0.1.0
6+
7+
**Docling4j** brings the functionalities of [Docling](https://github.com/docling-project/docling) in document understanding to Java® projects.
8+
9+
## Installation (WIP)
10+
The current version of this library is: 0.1.0
11+
12+
To use it in your project, define a dependency that contains the artifact coordinates (group id, artifact id and version)
13+
for the service, like this:
14+
15+
##### Maven
16+
17+
```xml
18+
<dependency>
19+
<groupId>com.ibm.docling</groupId>
20+
<artifactId>docling4j</artifactId>
21+
<version>0.1.0</version>
22+
</dependency>
23+
```
24+
25+
## Get help and support
26+
27+
Please feel free to connect with us using the [discussion section](https://github.com/docling-project/docling/discussions).
28+
29+
## Technical report
30+
31+
For more details on Docling's inner workings, check out the [Docling Technical Report](https://arxiv.org/abs/2408.09869).
32+
33+
## Code of conduct
34+
35+
See [Code of Conduct](https://github.com/docling-project/docling4j/blob/main/CODE_OF_CONDUCT.md) for details.
36+
37+
## References
38+
39+
If you use Docling in your projects, please consider citing the following:
40+
41+
```bib
42+
@techreport{Docling,
43+
author = {Deep Search Team},
44+
month = {8},
45+
title = {Docling Technical Report},
46+
url = {https://arxiv.org/abs/2408.09869},
47+
eprint = {2408.09869},
48+
doi = {10.48550/arXiv.2408.09869},
49+
version = {1.0.0},
50+
year = {2024}
51+
}
52+
```
53+
54+
## License
55+
56+
The Docling codebase is under MIT license.
57+
For individual model usage, please refer to the model licenses found in the original packages.
58+
59+
## LF AI & Data
60+
61+
Docling is hosted as a project in the [LF AI & Data Foundation](https://lfaidata.foundation/projects/).
62+
63+
### IBM ❤️ Open Source AI
64+
65+
The project was started by the AI for knowledge team at IBM Research Zurich.

0 commit comments

Comments
 (0)