https://github.com/opendevstack/ods-document-generation-svc
Document Generation Service used by the jenkins shared library to generate compliance documentes
https://github.com/opendevstack/ods-document-generation-svc
compliance documentation-generator
Last synced: 3 months ago
JSON representation
Document Generation Service used by the jenkins shared library to generate compliance documentes
- Host: GitHub
- URL: https://github.com/opendevstack/ods-document-generation-svc
- Owner: opendevstack
- License: apache-2.0
- Created: 2019-10-02T12:54:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-17T14:27:53.000Z (over 2 years ago)
- Last Synced: 2025-01-25T00:20:11.934Z (5 months ago)
- Topics: compliance, documentation-generator
- Language: Groovy
- Homepage:
- Size: 52.5 MB
- Stars: 0
- Watchers: 28
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# ODS Document Generation Service
A document generation service that transforms document templates in a remote Bitbucket repository into PDF documents.
## Distribute
```
make shadowJar
```
## Run
```
make run
```
## Test
```
make test
```
## Document Templates
When processing a template `type` at a specific `version`, and data into a document, the DocGen service expects the BitBucket repository to have a `release/${version}` branch that contains the template type at `/templates/${type}.html.tmpl`.
## Requirements
### Packages
- [wkhtmltopdf](https://wkhtmltopdf.org/)
### Environment
- `BITBUCKET_URL`
- `BITBUCKET_USERNAME`
- `BITBUCKET_PASSWORD`
- `BITBUCKET_DOCUMENT_TEMPLATES_PROJECT`
- `BITBUCKET_DOCUMENT_TEMPLATES_REPO`
## Reference
This project is based on https://github.com/jooby-project/gradle-starter.