Guide for deploying deprecator to a Heroku-like environment.
As you will see below, the App portion of deprecator only works for GitHub. GitLab is not supported. However, we would accept GitLab support if you are willing to contribute the work.
DEBUG
Optional.
Setting DEBUG to deprecator will print all debug statements available in the deprecator package.
DRY_RUN
Optional.
Setting DRY_RUN to true will cause deprecator to go through the deprecation process, including returning deprecation information, but it won't actually deprecate a package. Dry run mode makes it easy to see that deprecator is deprecating those packages, and versions, you expect, without any consequences. Then, when your confident of your results, you can remove the environment variable and deprecator will begin deprecating packages.
GITHUB_APPLICATION_ID
The App ID listed on your GitHub App configuration page after the Creating a GitHub App process.
GITHUB_APPLICATION_KEY
The contents of the PEM file generated as part of the Generating a private key process.
GITHUB_ENDPOINT
The fully qualified domain of your GitHub installation's API.
For GitHub.com, that would be https://api.github.com.
REDIS_URL
A fully qualified URL containing the connection parameters for a REDIS database in the form created by the Heroku Redis add-on and supported by the Redis client for Node.
RULES
A string encoded JSON object of rules that should be used by deprecator to deprecate packages fetched by the deprecator service.
As an example (enabling the all rule):
RULES='{"all": null}'WEB_CONCURRENCY
The number of server processes that should be spawned within each web container.
WORKER_CONCURRENCY
The number of worker processes that should be spawned within each worker container.