Skip to content

Commit f6e2abe

Browse files
committed
Update contributor docs and add comments
1 parent 9f9dc0a commit f6e2abe

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

Gruntfile.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,9 @@ module.exports = grunt => {
562562
]);
563563
grunt.registerTask('yui:build', ['yui']);
564564

565-
// builds the docs and the library before release
565+
// This is called by the "prepublishOnly" script in package.json to build the
566+
// documentation and the library after np bumps up the version number so that
567+
// the newly built files with the updated version number can be published.
566568
grunt.registerTask('prerelease', ['yui', 'build']);
567569

568570
grunt.registerTask('default', ['lint-no-fix', 'test']);

contributor_docs/release_process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ npm run release
2323
* `np` will then reinstall `node_modules` then run tests with `npm test`.
2424
* `np` will bump the version according to what was selected at the beginning.
2525
* If any step prior to this failed, the repo will be reverted to its initial state before running `npm run release`.
26+
* The task mentioned in `prepublishOnly` in `package.json` will run ( `grunt prerelease` ) to build the documentation and the library with the updated version number
2627
* The NPM package is published.
2728
* Release on NPM : __Only__ the files mentioned in `files` in `package.json` are published.
2829
* Tags and local commits are pushed to the git remote.
2930
* A draft release is created on github.com with changelogs that can be edited.
3031
* Create a Zip file `p5.zip` of `lib` folder (now includes the empty example), which should be uploaded in the GitHub Release draft created above.
3132
* After this process completes a window pointing at `release/` will open and it will contain all the files that should be uploaded as part of the Github Release.
3233
* Push the newly built library to [p5.js-release](https://github.com/processing/p5.js-release) repo for Bower.
33-
* Building the Docs: This is run as `grunt yui`
3434
* Push the newly built reference to [p5.js-website](https://github.com/processing/p5.js-website)
3535

3636
## Testing

tasks/build/browserify.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ module.exports = function(grunt) {
3838
});
3939

4040
if (isMin) {
41+
// These paths should be the exact same as what are used in the import
42+
// statements in the source. They are not relative to this file. It's
43+
// just how browserify works apparently.
4144
browseified = browseified
4245
.exclude('../../docs/reference/data.json')
4346
.exclude('../../../docs/parameterData.json')

0 commit comments

Comments
 (0)