From 97731bcaafabeca2536d868b5940d749d8c4a06b Mon Sep 17 00:00:00 2001 From: Chris Rankin Date: Tue, 3 Oct 2017 15:33:20 +0100 Subject: [PATCH] Add README for our automated API check. (#1793) * Add README for our automated API check. * Mention that the Corda Release Manager is expected to update the API file. --- .ci/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .ci/README.md diff --git a/.ci/README.md b/.ci/README.md new file mode 100644 index 0000000000..62b9669242 --- /dev/null +++ b/.ci/README.md @@ -0,0 +1,11 @@ +# !! DO NOT MODIFY THE API FILE IN THIS DIRECTORY !! + +The `api-current.txt` file contains a summary of Corda's current public APIs, +as generated by the `api-scanner` Gradle plugin. (See [here](../gradle-plugins/api-scanner/README.md) for a detailed description of this plugin.) It will be regenerated and the copy in this repository updated by the Release Manager with +each new Corda release. It will not be modified otherwise except under special circumstances that will require extra approval. + +Deleting or changing the existing Corda APIs listed in `api-current.txt` may +break developers' CorDapps in the next Corda release! Please remember that we +have committed to API Stability for CorDapps. + +# !! DO NOT MODIFY THE API FILE IN THIS DIRECTORY !!