| 1 | # NPM PUBLISHING
|
| 2 |
|
| 3 | ## Command Check
|
| 4 |
|
| 5 | Please verify the following before publishing to NPM
|
| 6 |
|
| 7 | [ ] All commands working:
|
| 8 | * deploy
|
| 9 | * invoke
|
| 10 | * remove
|
| 11 | * kill
|
| 12 | * script
|
| 13 | * configure
|
| 14 | * upgrade
|
| 15 |
|
| 16 | ## When Lambda Assets are Modified
|
| 17 |
|
| 18 | If the function assets were modified as part of this change
|
| 19 | make sure that upgrading has been implemented for this version
|
| 20 | of the assets.
|
| 21 |
|
| 22 | [ ] In the `versioning` directory, copy the existing assets under
|
| 23 | the current version into `assets`. (See `versioning/0.0.0/assets`
|
| 24 | for an example.)
|
| 25 |
|
| 26 | [ ] Update the current version number in `.slsart` in `lib/lambda`
|
| 27 | according to semantic versioning rules.
|
| 28 |
|
| 29 | [ ] Create a new directory under `versioning` that corresponds to the
|
| 30 | now updated version number in `.slsart`. (See `versioning/0.0.1/assets`
|
| 31 | for an example.)
|
| 32 |
|
| 33 | [ ] Implement upgrade from previous version to current version in
|
| 34 | `upgrade.js`. (See `versioning/0.0.1/upgrade.js` for an example.)
|
| 35 |
|
| 36 | [ ] Implement unit test cases for the `upgrade` in `tests/versioning/X.X.X/upgrade.spec.js`
|
| 37 |
|
| 38 | [ ] Implement integration test cases for version-to-version upgrades
|
| 39 | in `tests/integration/versioning/Y.Y.Y-X.X.X/upgrade.js`
|
| 40 |
|
| 41 | ## How to Publish
|
| 42 |
|
| 43 | [ ] Merge changes to `master` branch
|
| 44 |
|
| 45 | [ ] Using the `master` branch, run the `npm run publish` command. Follow the instructions
|
| 46 | on screen to change to the version number. This will tag the local git repository with that version.
|
| 47 |
|
| 48 | [ ] Once publishing is complete, perform a `git --tags push` which will push the tags to the server.
|