asvyazin / diadocsdk-java

Official Diadoc SDK for Java

         | Build Status

-------------|-------------- master | latest |

diadocsdk-java

diadocsdk-java является официальной Java-реализацией клиента, использующего публичный API Диадока. На данный момент поддерживаются только JRE/JDK, на который установлен КриптоПро JCP. Без КриптоПро JCP Diadoc SDK for Java работать не будет!

Как использовать?

Вы можете скачать готовый jar-файл diadocsdk-java со страницы релизов.

Его можно установить в локальный репозиторий maven и начать использовать как зависимость:

<dependencies>
  <dependency>
    <groupId>ru.kontur.diadoc</groupId>
    <artifactId>diadocsdk</artifactId>
    <version>1.36.2</version>
  </dependency>
</dependencies>

Сборка проекта с помощью maven

Для сборки проекта используется maven. Исполняемые файлы maven можно скачать на официальном сайте и установить по инструкции. В качестве альтернативы, можно установить maven с помощью Chocolatey. В итоге maven должен находиться в переменной среды PATH, чтобы его можно было вызвать из командной строки.

Стандартный способ сборки проекта с помощью maven (старт из корня репозитория):

mvn package

Можно поместить собранный пакет в локальный репозиторий командой:

mvn install

Окончательная сборка проекта (CI)

Для окончательной сборки проекта используется утилита Cake.

Запуск powershell-скрипта build.ps1 скачает утилиту Cake, если ее у вас нет, и запустит сборку проекта. Из командной строки этот скрипт можно запустить с помощью generate.bat.

Выполняется:

• генерация версии на основе тега
• компиляция proto-файлов
• компиляция DiadocApi

Добавление функциональности

• Сделайте Fork
• Создайте ветку для новой фичи (git checkout -b my-new-feature)
• Сделайте Commit изменений (git commit -am 'Add some feature')
• Сделайте Push новой ветки (git push origin my-new-feature)
• Создайте новый Pull Request