orbit-slingshot-notify

Accelerates the setup of a hosted, git managed templates repository.

Usage

This package is not intended to be installed as a dependency of any kind (e.g. dev, peer etc.). It contains a single executable .bin script, that will output all of the required files to begin building, validating and hosting templates.

Hosting the git managed template repository

The current implementation of Orbit notifications relies on your templates being hosted in a public git repository. The ideal place to set up this repository is the client template group in Gitlab.

Setting up your node environment

After cloning down the newly created repo add a .tool-versions file to the root with the following contents:

nodejs 18.12.1

N.B. In the above file you should set the nodejs value to the latest version suggested by the tech radar/node EOS seat

Slingshot a templates repository

Run the following command and follow any subsequent CLI prompts, to execute the latest notify-slingshot script version:

npx @rocketmakers/orbit-slingshot-notify orbit-slingshot-notify

Steps after executing slingshot-notify script

• [ ] Add a .gitignore file to the root of you repository
  • [ ] Add any relevant files you want ignored from source control
• [ ] Find & replace all instances of <INSERT_PROJECT_NAME> with your project name
• [ ] npm i to install all required dependencies
• [ ] Run each of the following commands to check all critical features are working (against the example templates/data provided out of the box)
  • [ ] npm run gen-payload-schemas to ensure generation of .json payload schemas is working correctly
  • [ ] npm run test-sendgrid-templates to ensure all schema and template validation scripts are working correctly
  • [ ] npm run compile-layouts to ensure all template compilation scripts are working correctly
• [ ] Push the templates to your target environment branch

Further reading

Additional docs on how orbit interacts with this type of template repository when sending notifications can be found in the README.md for @rocketmakers/orbit-template-services or @rocketmakers/orbit-template-http-repository