commit-message-install

commit-message-install

NPM install a package by name taken from the last commit message

Install

Requires Node version 6 or above.

npm install --save-dev commit-message-install

Use

Install NPM package from commit message

Imagine you have a CI build that installs NPM dependencies, but you also want to override one or more dependencies and test by creating a commit. Instead of changing package.json you can make a commit message with embedded JSON block describing custom installation. Then use this CLI tool to install based on the commit message.

Example CI file command

- npm i -g commit-message-install
- commit-message-install

If commit message is this

this will install package debug and chalk and while
installing them will set environment variable FOO to "bar".
The install will happen on all platforms

    ```json
    {
        "platform": "*",
        "packages": "debug,chalk"
    }
    ```

Happy installation

note platform can be * or specific one like darwin (from Node os.platform()) or a list of several platforms like darwin,linux

Debugging

• Run this tool with DEBUG=commit-message-install environment variable set
• Force reading commit message from a local file with --file <filename> option

Small print

Author: Gleb Bahmutov <[e-mail]> © 2017

• @bahmutov
• glebbahmutov.com
• blog

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2017 Gleb Bahmutov <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.