Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 2.11 KB

README.md

File metadata and controls

49 lines (31 loc) · 2.11 KB

Terms

exist-db CI

A database of terms drawn from the lists of terms and abbreviations in many volumes of the Foreign Relations of the United States. The application provides a searchable list of all entries.

Data sources

Status

The data and app are very preliminary and subject to reorganization.

Dependencies

  • The data in the data collection is XML.
  • The application runs in eXist. Requires 3.0+.
  • Building the installable package requires Apache Ant.

Installation

  • Check out the repository

  • Build the xar file(s) with following command:

    1. Single xar file: The collection.xconf will only contain the index, not any triggers!
    ```shell
    ant
    ```
    
    1. Since Releases have been automated when building locally you might want to supply your own version number (e.g. `X.X.X`) like this:
    
    ```shell
    ant -Dapp.version=X.X.X
    ```
    

Release

Releases for this data package are automated. Any commit to the master branch will trigger the release automation.

All commit message must conform to Conventional Commit Messages to determine semantic versioning of releases, please adhere to these conventions, like so:

Commit message Release type
fix(pencil): stop graphite breaking when too much pressure applied Patch Release
feat(pencil): add 'graphiteWidth' option Minor Feature Release
perf(pencil): remove graphiteWidth option

BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.
Major Breaking Release

When opening PRs commit messages are checked using commitlint.