Skip to content

Commit

Permalink
Generate docs before committing when publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardograca committed Nov 18, 2018
1 parent e5f5be0 commit 226c0b4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
3 changes: 2 additions & 1 deletion .github/CONTRIBUTING.md
Expand Up @@ -233,5 +233,6 @@ just make sure to follow the process explained below in the correct order.
shouldn't publish it yet, but just save it as a draft instead.
2. Update the `CHANGELOG.md` file and update the version number of `package.json`. For the changelog just follow the
format of the previous update. In general you should link to PRs instead of issues when mentioning changes. If the PRs'
descriptions are well written they should already include any associated issues. At this point there is no need to commit and/or push these changes since that is taken care of automatically by the release scripts.
descriptions are well written they should already include any associated issues. At this point there is no need to
commit and/or push these changes since that is taken care of automatically by the release scripts.
3. Just run `npm publish` and sit back.
12 changes: 5 additions & 7 deletions scripts/postpublish.sh
Expand Up @@ -11,17 +11,15 @@ echo "(Re)Creating bookshelf-source remote"
git remote remove bookshelf-source || true
git remote add bookshelf-source git@github.com:bookshelf/bookshelf.git

echo "Committing new release version w/ any outstanding changes"
echo "Regenerating documentation"
npm run jsdoc

echo "Committing new release version ($version) w/ any outstanding changes"
git commit -am "Release $version"

echo "Tagging version w/ number"
git tag $version

echo "Pushing commit to source master"
echo "Pushing commit and tags to source master"
git push bookshelf-source master

echo "Pushing new version tag to source master"
git push bookshelf-source master --tags

echo "Running gh-pages publish"
npm run jsdoc

0 comments on commit 226c0b4

Please sign in to comment.