Document how to set up credentials for publishing

[springmeyer]

Context

node-cpp-skel offers a working example for how to create a node c++ module, including scaffolding for critical pieces like publishing the binaries with node-pre-gyp. So, node-cpp-skel is the home to docs on best practices and also a working example.

Need

We need to document how to setup credentials correctly for publishing. The assumption is that the docs will be followed primarily by Mapbox staff, but the could also be used by anyone to publish to any bucket.

TODO:

• [x] Doc review: would love 👀 from @alulsh and @mapsam
• [x] Make node-cpp-skel scoped to @mapbox. Ensure publishing still works as expected.
  • Should publishing be to s3://<bucket>/@mapbox/<module name> or s3://<bucket>/<module name>? Currently the docs will break with publishing to @mapbox so that needs fixed.
• [ ] Work to make the methods more automated, easier to replicate in other repos (this will be applied to dozens).

[codecov-io]

Codecov Report

Merging #41 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #41   +/-   ##
=======================================
  Coverage   97.61%   97.61%           
=======================================
  Files           5        5           
  Lines         126      126           
=======================================
  Hits          123      123           
  Misses          3        3

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 7b7e678...555553c. Read the comment docs.

[daniel-j-h]

What's the progress here @springmeyer?

I was looking into this today and only found this as a guide on how to generate tokens.

Also there should maybe be a section on how to get the tokens in the node-pre-gyp readme, here: https://github.com/mapbox/node-pre-gyp#travis-automation It describes how to encrypt keys but not how to get the keys in the first place.

[springmeyer]

Update on this:

• I've revised the publishing section in the readme to be more detailed and less mbxcli specific.
• I've removed the keys from the travis.yml since the docs now recommend putting these in the travis settings UI.
• I've pushed a commit to put the module in the @mapbox namespace

The next steps here are to:

• [x] @mapsam runs through my latest docs once more, make sure they look good
• [x] @mapsam actually runs through using the docs to create a user for this repo and sets up publishing. (Currently publishing will be broken after I removed the keys in this branch)
• [x] Once publishing is confirmed to be working again in this branch, @mapsam merges this PR.

[mapsam]

@springmeyer I made some edits and have synced with master. Should we attempt to publish a binary from this branch or wait until we're in master?

[springmeyer]

@springmeyer I made some edits and have synced with master.

🙌

Should we attempt to publish a binary from this branch or wait until we're in master?

We should test that publishing works. Your call whether this is done before/after merge. Please run this out as you see fit.

One note is that I see a few travis failures that are mysterious:

not ok 2 test exited without ending
  ---
    operator: fail

I think these will have been resolved in master by removing node-pre-gyp from being used dynamically in the require after https://github.com/mapbox/node-cpp-skel/pull/44/files#diff-474b37290c5ca9ae5a02270ddfd00d96. So, I would recommend rebasing this branch against master and making sure travis passes after: git rebase -i master. Hopefully it should. If not, it is still not likely a problem with this branch and we can continue with a merge. Just would be nice to see things green.

[mapsam]

Hey @springmeyer - I synced with master yesterday and rerunning those two tests made them green, not sure why they failed. Looking good now!

We should test that publishing works.

Let's do this once we merge into master, as if we are doing a normal release.

[springmeyer]

Let's do this once we merge into master, as if we are doing a normal release.

👍 Okay, then please merge this now if you've landed all your edits. 🎉

I figure there might be glitches when this approach is applied to other repos (say the node-mapnik repo in a different org) but we can make fixes when/if we hit those.