1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00

Adapt paragraph dealing with API in readme.

This commit is contained in:
Marcus Holl 2018-12-19 09:01:40 +01:00
parent 6e0faa37ce
commit 05e4824268

View File

@ -51,8 +51,10 @@ provided pipeline library.
## API
All steps are intended to be used by Pipelines. All the classes / groovy-scripts
contained in the `src` folder are not part of the API and are subjected to change
without prior notice.
contained in the `src` folder are by default not part of the API and are subjected to change
without prior notice. Types and methods annotated with `@API` are considered to be API, used e.g.
from other shared libraries. Changes to those methods/types needs to be announced, disussed and
agreed.
# Requirements