KEMBAR78
docs(Plugin Developer Guide): More detailed lifecycle list and context descriptions by XC- · Pull Request #1880 · semantic-release/semantic-release · GitHub
Skip to content

Conversation

@XC-
Copy link
Contributor

@XC- XC- commented Apr 8, 2021

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.

XC- added 2 commits April 9, 2021 02:06
…t 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.
…ommits lifecycle documentation

analyzeCommits lifecycle context was missing documentation for "commits" list.
@XC-
Copy link
Contributor Author

XC- commented Apr 13, 2021

@gr2m @travi @pvdlg Any comments on this?

Copy link
Member

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you please remove the line breaks? The line breaks are unrelated changes and they make it harder to review your pull request.

Other than that this looks fantastic, thank you so much!

@XC-
Copy link
Contributor Author

XC- commented Apr 22, 2021

Certainly. Will do that tomorrow!

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.
@XC-
Copy link
Contributor Author

XC- commented Apr 25, 2021

@gr2m Sorry for the delay. Busier days than expected, but now the line breaks are removed :)

Copy link
Member

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thank you so much 💐

@gr2m gr2m merged commit 0435e35 into semantic-release:master Apr 25, 2021
@github-actions
Copy link

🎉 This PR is included in version 17.4.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants