ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-18 20:47:57 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
release/os/4.12
corda/.ci/README.md

12 lines
792 B
Markdown
Raw Permalink Normal View History

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-03 14:33:20 +00:00
# !! DO NOT MODIFY THE API FILE IN THIS DIRECTORY !!
The `api-current.txt` file contains a summary of Corda's current public APIs,
Update references to point to new repo and remove other redundant references. (#3151)
2018-05-15 16:09:50 +00:00
as generated by the `api-scanner` Gradle plugin. (See [here](https://github.com/corda/corda-gradle-plugins/blob/master/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
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-03 14:33:20 +00:00
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 !!
Reference in New Issue Copy Permalink