Skip to content

A plugin for semantic release that will be a drop in replacement for the standard generate to match the functionally of Release Drafter.

License

Notifications You must be signed in to change notification settings

Bugs5382/semantic-release-notes-drafter

Repository files navigation

semantic-release-notes-drafter

If you are using this plugin/NPM, please (:star:) star this repository, submit PRs, and issues. This way I can make sure the repositories with much usage can be maintained based off demand.

Table of Contents

  1. Keyword Definitions
  2. Documentation
  3. Acknowledgements
  4. License

Keyword Definitions

Keywords such as "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL". These are standardized terms for technology documentation interoperability. These words should have these meaning when you are reading them. They might be sans uppercase throughout the documentation, but they would have the same meaning regardless.

  • MUST - This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
  • MUST NOT - This phrase, or the phrase "SHALL NOT", mean that the definition is an absolute prohibition of the specification.
  • SHOULD - This word, or the adjective "RECOMMENDED", mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  • SHOULD NOT - This phrase, or the phrase "NOT RECOMMENDED", mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful. The full implications should be understood, and the case carefully weighed before implementing any behavior described with this label.
  • MAY - This word, or the adjective "OPTIONAL", mean that an item is truly optional. Any implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein, an implementation which does include a particular option MUST be prepared to interoperate with another implementation, which does not include the option (except, of course, for the feature the option provides.)

Documentation

Acknowledgements

License

Licensed under MIT.

About

A plugin for semantic release that will be a drop in replacement for the standard generate to match the functionally of Release Drafter.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published