productboard/webpack-deploy

Collection of useful utilities for deploying (not only) Webpack apps

Webpack deploy utilities

Collection of useful utilities for deploying (not only) Webpack apps

Installation

cd $YOUR_PROJECT
npm install --save-dev productboard/webpack-deploy

Configuration

Copy deploy-config-example.js and secrets-example.js into the root of your project and fit them to your needs. Also make sure you have ./node_modules/.bin in your $PATH.

Use

Build your Webpack project and run deploy [environment]. The script will automatically detect the build hash from build.log.

Commands

• deploy Batch command for quick deployment.
• deploy-s3 AWS S3 asset upload of build files.
• deploy-redis Redis deployment of revision index html file.
• activate-rev Redis activation of deployed revision.
• list-revs List of deployed revisions with meta information.
• list-active-rev List current active revision.
• rollbar-source-map Rollbar source map upload.
• slack-notify Slack channel notifier.
• git-deploy-tag Git tag creation and push to remote.

Other

Why Bash with Gulp?

Gulp is great for building, Bash for running tasks.

NPM >= 5.2.0 required

To find gulp binary also in mono-repos, npx is used. npx is included with npm from version 5.2.0.

TODO

• reupload/rewrite source map upload to fix activation of feature branches
• build sample app in monolithic repo
• forbid rev redeploy; force with --force
• add example ala https://github.com/FormidableLabs/webpack-stats-plugin
• list deployed feature branches
• init: config copy
• github PR deploy notification: https://developer.github.com/changes/2014-01-09-preview-the-new-deployments-api/
• rollbar deploy notification: https://rollbar.com/docs/deploys_bash/
• optional deploy message (for slack)
• list commits in slack message
• provide reference backend code snippet
• notification center updates
• friendlier error messages "Did you forget to ...?"
• abstract slack notifs into utils
• disallow activation of feature branches?
• get rid of the callback hell
• deploy tags don't work well with feature branches, they keep overwriting
• integrate new deploy info command

License

MIT

webpack-deploy's Issues

npm ERR! missing script: deploy-s3

Tried to run sudo npm run deploy-s3
npm ERR! missing script: deploy-s3

npm ERR! A complete log of this run can be found in:
npm ERR! /Users/mrmading/.npm/_logs/2017-07-01T08_06_40_149Z-debug.log

The major refactor for a new shiny look

As @LeZuse suggested in his PR review (#42), we should revisit the whole implementation and eventually deprecated gulp maybe even bash files.

I think it would be great to revisit the original project assumption /README.md@master#why-bash-with-gulp.
IMO, the landscape changed significantly in the last 4 years and it would maybe make sense to deprecate gulp altogether. I would definitely be up for something like oclif/oclif

Commands not found

Hi,
I'm following your Readme and when I come to running the listed commands it's not found.
I might be missing something obvious though, but I have for example tried with:

$ deploy-redis development
-bash: deploy-redis: command not found

$ gulp deploy-redis development
[22:10:52] No gulpfile found

I know I don't have a gulpfile, but do I need to add it and require something there?

Regards

Broken backward compatibility with one file deploys

Batch deploy.sh is broken now.

Workaround:

$ npm run build
$ deploy-s3 --env=staging
$ rollbar-source-map --env=staging
$ deploy-redis --env=staging
$ activate-rev --env=staging --rev=[your_revison]

Or use version <= v0.6.0:
npm i [email protected]

Remove productboard code references

It would be great to keep this project free from direct productboard references to make it more accessible for others in the OSS community.

Especially the deploy.sh (which might be removed in #43) could use some love in that regard. Maybe we could move these into ENV vars?

Can't find build.log

Hi,

I'm trying to use this module, but I can't get it working. First of all, the documentation lacks a lot of information on how to get this working. I'm guessing this is sort of like ember-cli-deploy, where you insert the HTML into Redis, which you can then use to host the static webapp from Express or something similar, or have I misunderstood the use of this module?

Anyhow, when I'm trying to use the deploy script, it is looking for hashes in the build log. But I can't find a way to have webpack create such a build log. I can't find any documentation on how to make it work.

Do you have an example project setup I can look at?

List revs task not compatible with multiple app version config

TODO:

• parse the new config format

Source maps shouldn't be required

Ahoj kluci!

I ran into issue while trying out this plugin. It seems like source maps are required by this task.

This doesn't seem right since not every compiler has support for source map generation.

This is full log:

$ ./node_modules/.bin/deploy staging                                                                                                                                                                                                           
Environment: ▇▇▇▇▇▇
Deploying branch ▇▇▇▇▇▇

Detected 1 build app versions:
        bfb▇▇▇▇▇▇▇▇▇▇▇▇: log

[21:43:44] Using config file ▇▇▇▇▇▇/deploy-config.js
[21:43:44] Using gulpfile ▇▇▇▇▇▇/webpack-deploy/gulpfile.js
[21:43:44] Starting 'deploy-s3'...
[21:43:44] Finished 'deploy-s3' after 38 ms
[21:43:44] Using config file ▇▇▇▇▇▇/deploy-config.js
[21:43:45] Using gulpfile ▇▇▇▇▇▇/node_modules/webpack-deploy/gulpfile.js
[21:43:45] Starting 'rollbar-source-map'...
[21:43:45] 'rollbar-source-map' errored after 320 μs
[21:43:45] TypeError: Cannot read property 'files' of undefined
    at uploadAppVersions (▇▇▇▇▇▇/node_modules/webpack-deploy/tasks/rollbar-source-map.js:72:23)
    at ▇▇▇▇▇▇/node_modules/webpack-deploy/tasks/rollbar-source-map.js:175:5
    at module.exports.getRevision (▇▇▇▇▇▇/node_modules/webpack-deploy/tasks/utils.js:39:69)
    at Gulp.<anonymous> (/▇▇▇▇▇▇/node_modules/webpack-deploy/tasks/rollbar-source-map.js:174:3)
    at module.exports (/Users/marek/Developer/pro-next/node_modules/orchestrator/lib/runTask.js:34:7)
    at Gulp.Orchestrator._runTask (▇▇▇▇▇▇node_modules/orchestrator/index.js:273:3)
    at Gulp.Orchestrator._runStep (▇▇▇▇▇▇/node_modules/orchestrator/index.js:214:10)
    at Gulp.Orchestrator.start (▇▇▇▇▇▇/node_modules/orchestrator/index.js:134:8)
    at ▇▇▇▇▇▇/node_modules/gulp/bin/gulp.js:129:20
    at _combinedTickCallback (internal/process/next_tick.js:67:7)

I'm using node 6.9.4 & webpack 1.12.15 but I don't think this is version specific.
build.log was generated by $ webpack >> build.log. App written in elm-lang (using webpack-elm).

I didn't dig deeper into issue yet - Do you think it will be easy patch or bigger story?

Thanks for publishing this package anyway! 🚀