ejhayes/deploybot repository overview

Deploybot improves your ability to visualize your deployments across all your repos.

Key features:

• Simplified deployment API endpoint that you can tie in with any system that performs deployments
• Automatic integration with the GitHub deployments API
• Automatic labeling of pull requests based on configurable labeler.yml file
• Automatically require your pull requests to include useful semantic labels (major, minor, patch)

⁠deploy

Looking to deploy this to your own environment? See the deployment guide⁠.

⁠quickstart

Once you've cloned this repo you can get started with the following:

npm i
npm run start:services
npm run db:migrate
npm run start:dev

Useful links:

• OpenAPI Documentation: http://localhost:3000/docs⁠
• Database:
  • Host: 127.0.0.1
  • Port: 6000
  • User: admin
  • Pass: admin
  • Database: deploybot
• Redis:
• Host: 127.0.0.1
• Port: 6001

⁠submitting deployment data

You can submit deployment data to deploybot via the HTTP POST to /deployment. An example request via cURL looks like:

curl -X 'POST' \
  'http://localhost:3000/deployment' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer my-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "some-app",
  "repository": "myorg/myrepo",
  "revision": "abcdef0",
  "status": "created",
  "cluster": "default",
  "project": "default",
  "groups": "groupA,groupB",
  "namespace": "default",
  "environment": "dev",
  "error_type": "RedisError",
  "error_message": "If I had an error I would put the message in here"
}'

Assuming this was a valid request the following GitHub deployment events would be created:

• deployment⁠
• deployment_status⁠

⁠pull request automatic labeling

Automatic labeling is supported if a .github/labeler.yml file is detected in the default branch (e.g. main):

---
version: 1
labels:
  - label: 'S'
    size-below: 10
  - label: 'whatever'
    files:
      - '.github'

⁠Contributing

If you have suggestions for how deploybot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide⁠.

⁠License

ISC⁠ © 2023 Eric Hayes

⁠Contributors ✨

Thanks goes to these wonderful people (emoji key⁠):

Eric Hayes⁠ 🚇⁠ 📖⁠ ⚠️⁠ 💻⁠

This project follows the all-contributors⁠ specification. Contributions of any kind welcome!