https://github.com/jason-fox/dita-unit-test-action
GitHub Action for DITA-OT Unit Test
https://github.com/jason-fox/dita-unit-test-action
code-coverage coverage dita-ot github-actions testing unit-testing
Last synced: about 2 months ago
JSON representation
GitHub Action for DITA-OT Unit Test
- Host: GitHub
- URL: https://github.com/jason-fox/dita-unit-test-action
- Owner: jason-fox
- License: mit
- Created: 2020-11-25T21:12:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-24T18:17:01.000Z (over 1 year ago)
- Last Synced: 2025-02-04T13:27:27.102Z (3 months ago)
- Topics: code-coverage, coverage, dita-ot, github-actions, testing, unit-testing
- Language: Shell
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DITA-OT Unit-Test GitHub action [
](https://unit-test-framework-for-dita-ot.rtfd.io)
This action installs and instruments a DITA-OT Plugin and then runs a supplied suite of tests across the DITA-OT plugin to provide Code Coverage and Unit Test Results.
## Inputs
### `dita-ot-version`
The version of DITA-OT to use. Defaults to `4.1.1`
### `plugin`
**Required** The name of the DITA-OT plugin to install and test.
### `setup-script`
The name of a bash script to run to install any dependencies prior to run the test. Defaults to `test-setup.sh` if not supplied.
### `prerequisites`
Comma separated list of additional DITA-OT plugins to install prior to installing the plugin under test.
### `plugin`
**Required** The name of the DITA-OT plugin to install and test.
if `COVERALLS_TOKEN` is added as an ENV, coverage results are pushed to [Coveralls](https://coveralls.io/).
## Example usage
```yaml
uses: jason-fox/dita-unit-test-action@master
with:
dita-ot-version: 3.7.2
plugin: 'fox.jason.prismjs'
setup-script: 'startup.sh'
prerequisites: 'org.doctales.xmltask,fox.jason.extend.css'
env:
COVERALLS_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
```
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE)