Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Friendly failures #223

Merged
merged 4 commits into from Apr 24, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 12 additions & 6 deletions lib/build.sh
@@ -1,11 +1,18 @@
build_failed() {
local warn=$(cat $warnings)
head "Build failed"
echo ""
cat $warnings | indent
info "We're sorry this build is failing! If you can't find the issue in application code,"
info "please submit a ticket so we can help: https://help.heroku.com/"
info "You can also try reverting to our legacy Node.js buildpack:"
info "heroku config:set BUILDPACK_URL=https://github.com/heroku/heroku-buildpack-nodejs#v63"
info "We're sorry this build is failing!"
info "Are you running into a common issue?"
info "https://devcenter.heroku.com/articles/troubleshooting-node-deploys"
info ""
if [ "$warn" != "" ]; then
info "During the build we spotted some likely problems:"
echo $warn | indent
else
info "If you're stuck, please submit a ticket so we can help:"
info "https://help.heroku.com/"
fi
info ""
info "Love,"
info "Heroku"
Expand All @@ -15,7 +22,6 @@ build_succeeded() {
head "Build succeeded!"
echo ""
(npm ls --depth=0 || true) 2>/dev/null | indent
cat $warnings | indent
}

get_start_method() {
Expand Down
4 changes: 2 additions & 2 deletions lib/common.sh
Expand Up @@ -17,8 +17,8 @@ info() {
warning() {
local tip=$1
local url=$2
echo "WARNING: $tip" >> $warnings
echo "${url:-https://devcenter.heroku.com/articles/nodejs-support}" >> $warnings
echo "- $tip" >> $warnings
echo " ${url:-https://devcenter.heroku.com/articles/nodejs-support}" >> $warnings
echo "" >> $warnings
}

Expand Down
6 changes: 3 additions & 3 deletions lib/warnings.sh
Expand Up @@ -3,16 +3,16 @@ warn_node_engine() {
if [ "$node_engine" == "" ]; then
warning "Node version not specified in package.json" "https://devcenter.heroku.com/articles/nodejs-support#specifying-a-node-js-version"
elif [ "$node_engine" == "*" ]; then
warning "Avoid semver ranges like '*' in engines.node" "https://devcenter.heroku.com/articles/nodejs-support#specifying-a-node-js-version"
warning "Dangerous semver range (*) in engines.node" "https://devcenter.heroku.com/articles/nodejs-support#specifying-a-node-js-version"
elif [ ${node_engine:0:1} == ">" ]; then
warning "Avoid semver ranges starting with '>' in engines.node" "https://devcenter.heroku.com/articles/nodejs-support#specifying-a-node-js-version"
warning "Dangerous semver range (>) in engines.node" "https://devcenter.heroku.com/articles/nodejs-support#specifying-a-node-js-version"
fi
}

warn_node_modules() {
local modules_source=$1
if [ "$modules_source" == "prebuilt" ]; then
warning "Avoid checking node_modules into source control" "https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-"
warning "node_modules checked into source control" "https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-"
elif [ "$modules_source" == "" ]; then
warning "No package.json found"
fi
Expand Down
3 changes: 3 additions & 0 deletions test/fixtures/dangerous-range-greater-than/package.json
Expand Up @@ -6,6 +6,9 @@
"type" : "git",
"url" : "http://github.com/example/example.git"
},
"dependencies": {
"forcefailure": "*"
},
"engines": {
"node": ">0.4"
}
Expand Down
3 changes: 3 additions & 0 deletions test/fixtures/dangerous-range-star/package.json
Expand Up @@ -6,6 +6,9 @@
"type" : "git",
"url" : "http://github.com/example/example.git"
},
"dependencies": {
"forcefailure": "*"
},
"engines": {
"node": "*"
}
Expand Down
191 changes: 191 additions & 0 deletions test/fixtures/many-warnings/node_modules/hashish/README.markdown

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.