https://github.com/danger/danger-plugin-api
A gem for Danger plugin authors to use to use for SemVer on the API
https://github.com/danger/danger-plugin-api
Last synced: about 1 year ago
JSON representation
A gem for Danger plugin authors to use to use for SemVer on the API
- Host: GitHub
- URL: https://github.com/danger/danger-plugin-api
- Owner: danger
- License: mit
- Created: 2016-08-25T21:24:36.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-25T21:36:36.000Z (almost 10 years ago)
- Last Synced: 2025-04-07T18:42:05.735Z (about 1 year ago)
- Language: Ruby
- Size: 6.84 KB
- Stars: 6
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Danger Plugin API contract
This repo contains a single gem, it represents the current version of the API, and what the minimum version of Danger supports it.
Check the current version by clicking: [lib/danger/plugin/api/version.rb](lib/danger/plugin/api/version.rb).
This frees plugin authors from being tied to a project which is aggressive on [semantic versioning](http://semver.org). As long as the plugin API stays the same
then as an author you can be safe in the knowledge that a version bump on Danger has not changed the external API.
## What do I define as a public API?
Well that one is a bit tricky, for plugins that is anything that can be found on the [Danger.Systems#reference](http://danger.systems/reference.html). Additions to the exposed DSL probably won't get bumps to this gem's versions, but breaking changes e.g. removals or renames definitely will.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/danger-plugin-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).