Kelsus Spot API Package

Description

Post deploy script for Kelsus Spot

Spot Repository

• Once the script is executed, it will send a POST request to the Spot API
• This request will generate a new service/application with an activity.
• On the app you will be able to assign the service to a client, and on each deploy it will trigger the script again, generating a new activity.
• The script supports differents environments for the same app.

Execute

Run the npx command with optional args to execute the post deploy script.

npx @kelsus/api-spot-package

Parameters

For CI

The Spot script takes variables from differents CIs in order to fill the data that will be sent to the API.

• SEED:
  • application: "SEED_APP_NAME",
  • service: "SEED_SERVICE_NAME",
  • environment: "SEED_STAGE_NAME",
  • version: "SEED_BUILD_ID",
• CircleCI:
  • service: "CIRCLE_PROJECT_REPONAME",
  • environment: "CIRCLE_BRANCH",
  • version: "CIRCLE_BUILD_NUM",
• Netlify:
  • url: "URL",
  • application: "SITE_NAME",
  • environment: "CONTEXT",
  • version: "BUILD_ID",
• Amplify:
  • environment: "AWS_BRANCH",
  • version: "AWS_JOB_ID"

Allowed args parameters

You can still customize parameters calling them on the npx execution.

e.g:

npx spot-package --service=api-spot-package

--id
--eventType
--createdAt
--commitId
--commitBranch
--commitMessage
--commitDate
--application
--service
--status
--environment
--version
--serviceType
--runtime
--runtimeVersion
--serviceUrl
--repoUrl
--lastDeploy
--changelog

Alternative Env Variables

In case that you want to overwrite data, Spot will look for these Env Variables

- application = "APP_NAME"
- service = "SERVICE_NAME"
- environment = "ENVIRONMENT_NAME"
- status = "BUILD_STATUS"
- version = "VERSION"
- url = "APP_URL"

Call the function

• npm install @kelsus/api-spot-package
• You can invoke the main() function with require('@kelsus/api-spot-package') and pass the parameters through the function.
• E.g:

// Require package
const SPOT = require('@kelsus/api-spot-package');

//Call the function an pass parameters as an object
SPOT.main({application: 'api-spot-package', env: 'develop'});

Request body

activity: 
    {
        id,
        service,
        eventType,
        createdAt,
        commitId,
        commitMessage,
        commitDate,
        commitBranch,
        application,
        status,
        environment,
        version,
        serviceType,
        runtime,
        runtimeVersion,
        serviceUrl,
        repoUrl,
        lastDeploy,
        changelog
    }

Environment Variables

Make sure that SPOT_API_KEY is available on build with a valid value.

SPOT_API_KEY

Push a new version

• Publishing is automated via CircleCI, so please if you want to add a new version of it, merge it on master branch and change the version.

• After pushing a new version, update the Version History below.

CircleCI Environment Variables

NPM_TOKEN: NPM personal access token.

Version History

• 1.0.0
  • Initial Release
  • Spot API Key
  • NPX Executable
  • NPX Run process arguments
  • Activity POST - Git repository data
  • API Key and Parameters fix
• 1.1.0
  • Changelog Feature
• 1.2.0
  • No parameters required to run
  • Get data from different CIs
  • npx @kelsus/api-spot-packge
• 1.3.0
  • Node image updated on CircleCI