The documentation says:
> If the `prerelease` property is set to `true` the `name` value will be used.
But then the example referring to this behaviour has the the `prerelease` value set to `'beta'` instead of `true`.
The link to the secrets and environment variables was broken since the documentation changed.
I pointed the link to the URL that made most sense, since users can choose to create the secret wherever they want.
Updates the included CircleCI config file example.
* Now uses 2.1 style config
* Uses Node Orb
* Use pre-defined node/test job
* Uses Matrix jobs to test multiple node versions.
* Updated Node versions
* Using new CircleCI docker images (from node executor)
* Updated language/terminology in description
A correction to the earlier documentation: the "nextRelease" object is NOT similar to the
lastRelease and there are some differences. Because of this, the object is now documented as a
separate entry. Added also information on how the error handling should be done so that
semantic-release would be able to handle errors from plugins properly and call "fail" lifecycle
plugins. Included some more advanced information on how the analyzeCommits-lifecycle plugins work
and how the result of the initial analyzer can be overridden. This is an edge case, but could happen
and is good to understand.
* docs(Plugin Developer Guide): More detailed lifecycle list and context descriptions
This commit will improve the following in the Plugin developer guide:
* Lifecyle list more complete (previous was missing some lifecycles)
* Context object has been now described in more detail per lifecycle
* Some readability/maintainability fixes to the markdown file itself
to make it easier to edit and read in an editor.
* docs(Plugin Developer Guide): Added missing context field to analyzeCommits lifecycle documentation
analyzeCommits lifecycle context was missing documentation for "commits" list.
* docs(developer-guide): remove line breaks added in an earlier commit
As per requested in the code review, the line breaks that were added in an earlier commit are now
removed. While this does make reading the text just slightly more difficult (to see the whole
picture), the benefit of making code reviews easier does outweight the admittedly small benefit.
The old list was missing analyzeCommits lifecycle and the verification lifecycle was incorrectly listed as "verify", when it should currently be "verifyConditions" in order to properly load.
Bolaji Ayodeji