[Releases] Streamline the release process
@Olshansk is already working on this.
Since Mar 25, 2025.
Assessment
This issue has not been assessed yet.
Description
Objective
Streamline the release process of PATH.
Origin Document
https://discord.com/channels/824324475256438814/1263851886486880356/1314302316266000414
Goals
- Share patterns & logic across poktroll, PATH, PADS
- Enable anyone to tag & create new releases
- Automate the right amount of the release process and keep the rest manual
Deliverables
-
Docker image
- Build and publish docker image on every merge to
main - Attach the
main&latesttag to the latest docker images (ephemeral tag) - Attach the
shato each one (static tag) - For official releases, attach the corresponding
shaas well - Example: https://github.com/pokt-network/poktroll/blob/main/.github/workflows/main-build.yml
- Build and publish docker image on every merge to
-
Tagging new releases
- Create Makefiles for tagging new releases
manually - One for minor releases (git tag + git push + helper to create the release)
- One for major releases (git tag + git push + helper to create the release)
- Example: https://github.com/pokt-network/smt#release-tags
- Create Makefiles for tagging new releases
-
Publish artifacts
- Publish artifacts
automaticallyfor multiple environments every time a new release is published - Mimic the results of this release process (i.e. 4 types of binaries): https://github.com/pokt-network/poktroll/releases/tag/v0.0.11
- Example: https://github.com/pokt-network/poktroll/blob/main/.github/workflows/release-artifacts.yml
- Publish artifacts
-
The following will be done by @Olshansk and copy-pasted across the different repos.
-
Document all of the above in a new page in docusaurus
- Reference the docker image ghrc repo
- Example of how to pull the docker image
- Explain the makefiles available
- Explain when to use the makefile targets
- List the environments supports
- Link to the existing releases
Creator: @Olshansk
Co-Owners: @commoddity @HebertCL @okdas
- Dominant language
- Go
- Stars
- 12
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from pokt-network/path
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
pokt-network/path#509 ·
-
bug gateway
Difficulty 4/5 3-5 days Newbie friendliness 45/100
pokt-network/path#477 ·
-
config documentation evm portal-db portal-ui qos
Difficulty 4/5 3-5 days Newbie friendliness 48/100
pokt-network/path#475 · 1 comment ·
-
[RADIX][TRON][SUPPLIER] Suppliers should not have to append additional API paths in their RM configMay be free again @adshmh claimed this 404 days ago, and no pull request is open. Openqos
pokt-network/path#443 · 1 comment · 3 assignees ·
-
[PORTALDB][CONFIG] Surface sanctions settings and thresholds as configurables in both the Config files and Portal DBMay be free again @commoddity claimed this 426 days ago, and no pull request is open. Openconfig documentation portal-ui qos
pokt-network/path#409 · 1 assignee ·
All issues in pokt-network/path
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
oasdiff/oasdiff#1337 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
dataiku/kiji-proxy#635 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
hyperledger-firefly/signer#126 ·
-
agent-review-finding chore
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
jordansmall/spindrift#5748 ·
Maintainers usually reply within 1 day