Release

Creating a new bot release

The release of the bot is done by this script: ./botRelease.sh v{VERSION}

• all the script does is keep the branch convention
  • squashes all new changes into one commit
  • the commit is named as the version to be released
  • release tags
  • force-pushes to remote
  • this makes the branch have an abridged history with only release commits
• the version should match the formatting in CHANGELOG.md
  • ie v3.0.1
  • without correct formatting, the changelog will be empty
• release_bot branch is protected, so only project admins can push there
• pushing to release_bot branch triggers the workflow that
  1. generates the Docker image
  2. publishes the Docker image to GitHub
  3. publishes the Docker image to fly.io

graph TD
    DEV[dev] -->|squash and commit; push| RELEASE[release_bot]
    RELEASE -->|triggers| WORKFLOW[deploy_bot.yml]
    WORKFLOW -->|builds| DOCKER[Docker image]
    WORKFLOW -->|push| CLOUD[fly.io]
    DOCKER --> CLOUD


style DEV fill:#30363d,stroke:#8b949e,color:#e6edf3
style RELEASE fill:#30363d,stroke:#8b949e,color:#e6edf3
style WORKFLOW fill:#db61a2,stroke:#bf4080,color:#fff
style DOCKER fill:#2496ed,stroke:#1a7dc4,color:#fff
style CLOUD fill:#7b3ff2,stroke:#5a2db8,color:#fff

Loading