diff --git a/PR_REVIEW.md b/PR_REVIEW.md
index f991a0254f5..93525485cfa 100644
--- a/PR_REVIEW.md
+++ b/PR_REVIEW.md
@@ -5,6 +5,17 @@ If the PR is for a standard bid adapter or a standard analytics adapter, just th
For modules and core platform updates, the initial reviewer should request an additional team member to review as a sanity check. Merge should only happen when the PR has 2 `LGTM` from the core team and a documentation PR if required.
+### Running Tests and Verifying Integrations
+
+General gulp commands include separate commands for serving the codebase on a built in webserver, creating code coverage reports and allowing serving integration examples. The `review-start` gulp command combinese those into one command.
+
+- Run `gulp review-start`, adding the host parameter `gulp review-start --host=0.0.0.0` will bind to all IPs on the machine
+ - A page will open which provides a hub for common reviewer tools.
+ - If you need to manually acceess the tools:
+ - Navigate to build/coverage/lcov-report/index.html to view coverage
+ - Navigate to integrationExamples/gpt/hellow_world.html for basic integration testing
+ - The hello_world.html and other exampls can be edited and used as needed to verify functionality
+
### General PR review Process
- All required global and bidder-adapter rules defined in the [Module Rules](https://docs.prebid.org/dev-docs/module-rules.html) must be followed. Please review these rules often - we depend on reviewers to enforce them.
- Checkout the branch (these instructions are available on the github PR page as well).
diff --git a/gulpfile.js b/gulpfile.js
index 879e34ae588..b7a9e442a8c 100644
--- a/gulpfile.js
+++ b/gulpfile.js
@@ -86,7 +86,8 @@ function viewCoverage(done) {
connect.server({
port: coveragePort,
root: 'build/coverage/lcov-report',
- livereload: false
+ livereload: false,
+ debug: true
});
opens('http://' + mylocalhost + ':' + coveragePort);
done();
@@ -94,6 +95,19 @@ function viewCoverage(done) {
viewCoverage.displayName = 'view-coverage';
+// View the reviewer tools page
+function viewReview(done) {
+ var mylocalhost = (argv.host) ? argv.host : 'localhost';
+ var reviewUrl = 'http://' + mylocalhost + ':' + port + '/integrationExamples/reviewerTools/index.html'; // reuse the main port from 9999
+
+ // console.log(`stdout: opening` + reviewUrl);
+
+ opens(reviewUrl);
+ done();
+};
+
+viewReview.displayName = 'view-review';
+
// Watch Task with Live Reload
function watch(done) {
var mainWatcher = gulp.watch([
@@ -383,4 +397,8 @@ gulp.task('e2e-test', gulp.series(clean, setupE2e, gulp.parallel('build-bundle-p
gulp.task(bundleToStdout);
gulp.task('bundle', gulpBundle.bind(null, false)); // used for just concatenating pre-built files with no build step
+// build task for reviewers, runs test-coverage, serves, without watching
+gulp.task(viewReview);
+gulp.task('review-start', gulp.series(clean, lint, gulp.parallel('build-bundle-dev', watch, testCoverage), viewReview));
+
module.exports = nodeBundle;
diff --git a/integrationExamples/reviewerTools/index.html b/integrationExamples/reviewerTools/index.html
new file mode 100755
index 00000000000..2732cb4fd88
--- /dev/null
+++ b/integrationExamples/reviewerTools/index.html
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+ Prebid Reviewer Tools
+
+
+
+
+
+
+
+
Reviewer Tools
+
Below are links to the most common tool used by Prebid reviewers. For more info on PR review processes check out the General PR Review Process page on Github.