Skip to content

Commit

Permalink
Remove Grunt from the release/deploy mix.
Browse files Browse the repository at this point in the history
A couple of reasons:
1. To use 2FA via OTP you require an interactive CLI at `npm publish` (fails via Grunt with ERR! code EOTP)
2. The use of a Grunt task for this purpose, running a single command, was adding unnecessary complexity - it was a shallow shim
  • Loading branch information
Quintin Willison committed Apr 17, 2020
1 parent c9902a9 commit ae4736f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 12 deletions.
9 changes: 0 additions & 9 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,4 @@ module.exports = function (grunt) {
]);
}
);

grunt.registerTask('release:git-push', 'Pushes to git', execExternal('git push origin master --follow-tags'));

grunt.registerTask('release:npm-publish', 'Deploys to npm', execExternal('npm publish . --access public'));

grunt.registerTask('release:deploy', 'Pushes a new release to github and deploys to npm', [
'release:git-push',
'release:npm-publish',
]);
};
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,11 @@ Browser testing supported by

for which you will need to configure environment variables for `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESSKEY`.

## Release checklist
## Release Procedure

On the `master` branch:

1. Run `npm run grunt -- release:patch` (or "major", "minor" or "prepatch" as appropriate - see [grunt-bump Usage Examples](https://github.com/vojtajina/grunt-bump#usage-examples))
2. Run `npm run grunt -- release:deploy`
3. Visit [tags](https://github.com/ably-forks/vcdiff-decoder/tags) and draft new release for the newly created tag
2. Run `git push origin master --follow-tags`
3. Run `npm publish . --access public` ([this package](https://www.npmjs.com/package/@ably/vcdiff-decoder) is configured to require that [2FA](https://docs.npmjs.com/configuring-two-factor-authentication) is used by publishers)
4. Visit [tags](https://github.com/ably-forks/vcdiff-decoder/tags) and draft new release for the newly created tag

0 comments on commit ae4736f

Please sign in to comment.