Before you begin

Setting up the snap-in

  1. Create a new repo from the ADaaS template repo. Select Use this template and then Create a new repository.
  2. Copy .env.example to .env and fill in the required variables.
  3. Configure a keyring for the external system in the manifest.yaml. Refer to Keyrings for instructions.
  4. Deploy a draft version of your snap-in to your dev org using make deploy.
  5. Install the snap-in in your DevRev at Settings > Snap-ins > Install snap-in.
  6. Define the connection at Settings > Imports > Connections.
  7. Create an import at Settings > Imports > Import.

Observability

  • To observe logs from your snap-in in your development environment:
    devrev snap_in_package logs | jq
  • To open logs in your favorite editor:
    devrev snap_in_package logs | code -

For more information, refer to Debugging.

Built with