ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-25 07:31:10 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
b5f5f3f975
corda/.ci/README.md
Chris Rankin 47f88cd088 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.
2017-10-05 11:24:20 +01:00

752 B
Raw Blame History

!! 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 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 !!