Skip to content
This repository has been archived by the owner on Oct 18, 2023. It is now read-only.

Latest commit

 

History

History
83 lines (55 loc) · 3.52 KB

README.adoc

File metadata and controls

83 lines (55 loc) · 3.52 KB
Raw

API Library

vert.x 4.3.6 purple badge

This library is used by the Cyface Vert.X APIs like the Cyface Data Collector software.

It contains shared code required by most of the APIs, like authentication and setup.

If you require this software under a closed source license for you own projects, please contact us.

Changes between versions are found in the Release Section.

The project uses Gradle as the build system. It is set up as a Gradle multi project build. There is one general categories of subprojects. The libraries shared by several Cyface executables which are grouped in libs. The following sections provide an overview about those projects.

API

Vert.X classes shared between multiple Cyface Vert.X API projects.

Release a new Version

  • version in root build.gradle is automatically set by the CI

  • Just tag the release and push the tag to Github

  • The Github package is automatically published when a new version is tagged and pushed by our Github Actions to the Github Registry

  • The tag is automatically marked as a 'new Release' on Github

Publishing artifacts to GitHub Packages manually

The artifacts produced by this project are distributed via GitHubPackages. Before you can publish artifacts you need to rename gradle.properties.template to gradle.properties and enter your GitHub credentials. How to obtain these credentials is described here.

To publish a new version of an artifact you need to:

  1. Increase the version number of the subproject within the build.gradle file

  2. Call ./gradlew publish

This will upload a new artifact to GitHub packages with the new version. GitHub Packages will not accept to overwrite an existing version or to upload a lower version. This project uses semantic versioning.

Licensing

Copyright 2018-2023 Cyface GmbH

This file is part of the Cyface API Library.

The Cyface API Library is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The Cyface API Library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the Cyface API Library. If not, see http://www.gnu.org/licenses/.