Security PR Tool

Quick Start

1. npm install
2. npm run build
3. Go to https://smee.io/new and note the url generated
4. Create a github app making note of the app ID and the webhook secret and create a private key
5. Create a .env file like so:

   # The ID of your GitHub App
   APP_ID=...
   WEBHOOK_SECRET=...
   PRIVATE_KEY_PATH=./yourprivatekeyhere.pem
   # Use `trace` to get verbose logging or `info` to show less
   LOG_LEVEL=debug
   
   # Go to https://smee.io/new set this to the URL
   # that you are redirected to.
   WEBHOOK_PROXY_URL=https://smee.io/asdfg
   
   # Jenkins
   JENKINS_URL=...
   JENKINS_FEATURE_JOB=...
   JENKINS_BUILD_TOKEN=...
   JENKINS_USER=jenkins
   JENKINS_APP_TOKEN=...

6. npm run dev
7. Generate requests by commenting on PRs etc.

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.

The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.