Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Streamline release process #622

Open
8 tasks
okdas opened this issue Jun 18, 2024 · 1 comment
Open
8 tasks

[Documentation] Streamline release process #622

okdas opened this issue Jun 18, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@okdas
Copy link
Member

okdas commented Jun 18, 2024

Objective

shannon already has automation to build binaries and production-grade container images for releases.

The objective is to add documentation for the protocol team to cut & publish new releases.

Origin Document

Goals

  • Streamline the release process
  • Unblock protocol team from publishing releases and pre-releases often

Non-goals

  • Handling on-chain upgrades & features switches
  • Protocol upgrade playbook

Deliverables

  • Add a copy-paste template for release announcements.
    • [TBD] Verify if any of this should be automated by Github Action.
  • Document the process and post instructions on dev.poktroll.com for internal use by the protocol team.
  • Add the appropriate Makefile helpers

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @okdas
Co-owner: @Olshansk

@okdas okdas added the documentation Improvements or additions to documentation label Jun 18, 2024
@okdas okdas added this to the Shannon Beta TestNet Launch milestone Jun 18, 2024
@okdas okdas self-assigned this Jun 18, 2024
@Olshansk
Copy link
Member

@okdas I updated some details and deliverables. Will be creating another ticket dedicated to protocol upgrades

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🏗 In progress
Development

No branches or pull requests

2 participants