Skip to content

Commit 31ba34a

Browse files
committedNov 29, 2017
docs(CONTRIBUTING): add note about how type definitions and API docs are generated and published automatically
1 parent 762a7e3 commit 31ba34a

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed
 

‎CONTRIBUTING.md

+3
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,7 @@ Only one version number is bumped at a time, the highest version change trumps t
4444
Besides publishing a new version to npm, semantic-release also creates a git tag and release
4545
on GitHub, generates changelogs from the commit messages and puts them into the release notes.
4646

47+
Before the publish it runs the `npm run build` script which generates type definitions for Flow & Typescript based on the [templates](scripts/templates/).
48+
The script also generates the API docs. After the publish, the API docs are automatically pushed to the `gh-pages` branch which updates the documentation at [octokit.github.io/node-github](http://octokit.github.io/node-github/).
49+
4750
If the pull request looks good but does not follow the commit conventions, use the "Squash & merge" button.

0 commit comments

Comments
 (0)
Please sign in to comment.