Skip to content

docs: update release docs#8664

Merged
srdtrk merged 2 commits intomainfrom
gjermund/update-release-docs
Oct 10, 2025
Merged

docs: update release docs#8664
srdtrk merged 2 commits intomainfrom
gjermund/update-release-docs

Conversation

@gjermundgaraba
Copy link
Contributor

Description

closes: #XXXX


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Include changelog entry when appropriate (e.g. chores should be omitted from changelog).
  • Wrote unit and integration tests if relevant.
  • Updated documentation (docs/) if anything is changed.
  • Added godoc comments if relevant.
  • Self-reviewed Files changed in the GitHub PR explorer.
  • Provide a conventional commit message to follow the repository standards.

@codecov
Copy link

codecov bot commented Oct 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.31%. Comparing base (ec278c8) to head (c7d2f15).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8664   +/-   ##
=======================================
  Coverage   58.31%   58.31%           
=======================================
  Files         319      319           
  Lines       22821    22821           
=======================================
  Hits        13307    13307           
  Misses       8907     8907           
  Partials      607      607           
Flag Coverage Δ
08-wasm 65.99% <ø> (ø)
e2e 1.14% <ø> (ø)
ibc-go 63.74% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@srdtrk srdtrk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm. Great documentation. I left some questions


### 0: Before release

1. Before tagging a new release, make sure to run the [compatibility e2e test suite](https://github.com/cosmos/ibc-go/actions/workflows/e2e-compatibility.yaml) for the corresponding release line.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we also run some upgrade tests?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, good question. It was never part of the release flow. Maybe it should be. I don't have a super good overview over those tests, and if there would need to be any changes to support a specific branch or whatever 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I checked a bit more, and I don't know what the best procedure is, but what I did for v10.4.x leading up to the release was building a tag and updating ci-e2e-config.yaml:

  - planName: "v10"
    tag: "branch-release-v10.4.x"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I put this into the docs?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Maybe mark it optional if you don't always do this?

- github.com/cosmos/ibc-go/v10 v10.3.0
+ github.com/cosmos/ibc-go/v10 v10.4.0
```
3. Create a PR to the release branch, and after CI finishes, merge it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do the e2e compatibility tests cover submodules?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't look that way

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can see what it runs in e2e-compatibility.yaml

@srdtrk srdtrk merged commit 0262926 into main Oct 10, 2025
18 checks passed
@srdtrk srdtrk deleted the gjermund/update-release-docs branch October 10, 2025 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants