deploya-trigger-ph v2.1.5

deploya-trigger

deploya-trigger helps us to trigger deploy through deploya in our applications!

Install

yarn add -D @ikea-customer-self-serve/deploya-trigger

// package.json

{
    ...
    "scripts": {
        "deploy": "deploya-trigger"
    },
    ...
}

Configuration

Create a new file in the root of your application called .deployarc (JSON-format)

// example config for order history

{
    "locales": [{ "country": "ca", "languages": ["en", "fr"] }],        // Required array   -   markets that we are allowed to deploy to
    "s3host": "order",                                                  // Required string  -   which domain you will host the application on
    "hostPath": "history"                                               // Required string  -   which sub-path your app will run on, e.g /se/sv/{hostPath}
    "project": "order-history"                                          // Required string  -   what Deploya project you want to use
}

CI mode

To run deploya-trigger in a CI mode set CI-environment variable to true, this means that you need to supply some of the config as environment variables

Environment variables

• MARKETS - Required - which markets you want to deploy, use comma to separate the different markets e.g MARKETS=se,de,ca
• ENVIRONMENT - Required - which environment you want to deploy to
• TAG - Required - what tag or branch you want to deploy
• SUFFIX - Optional - if you want to the deploy the app to a sub-path

Dry runs

If you only want to see if you configured the deploy tool in correct way you can add --dry to the command and it will skip the request to deploya