In order to run the project locally we need node>=16
and npm>=8
installed on our development machines.
To run the GitHub App code against a test repository, add TEST_REPOSITORY
to your local .env
file.
To start the server locally at port 8888
:
npm start
Install the Netlify GitHub app in the repository and configure the environment variables listed in .env.example.
Register a new GitHub application with the permissions issues:write
and metadata:read
. Set the webhook URL to <your netlify domain>/api/github/webhooks
.
Once registered, you will be able to obtain all the GITHUB_APP_*
credentials from the app settings.
It is advised you generate the WEBHOOK_SECRET
using the following command:
# random key strokes can work too if you don't have ruby(??)
ruby -rsecurerandom -e 'puts SecureRandom.hex(20)'
Now, go to the very bottom and click "Generate a new private key" and open a terminal in the location of the downloaded file.
Rename this file to private-key.pem
for the next command to work:
openssl pkcs8 -topk8 -inform PEM -outform PEM -nocrypt -in private-key.pem -out private-key-pkcs8.key
Copy the contents of private-key-pkcs8.key
to GITHUB_APP_PRIVATE_KEY
. Note the
string will need to be on one line joined with \n
.
Go to your server of choice, click "Settings" and then "Integrations", create a new webhook and copy the URL and paste that value into DISCORD_WEBHOOKS_URL
.
Now you are good to use the wrangler release workflows and deploy to production!
We encourage you to contribute to Open Sauced! Please check out the Contributing guide for guidelines about how to proceed.
Got Questions? Join the conversation in our Discord.
Find Open Sauced videos and release overviews on our YouTube Channel.
MIT © Open Sauced