Tag web_backend / web_frontend submodule commits when cutting a release
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 67/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- git, github
- Domain
- release
Research direction
Read RELEASING.md, especially the release and release candidate steps around tagging the merge commit. Add instructions to tag and push each pinned web_backend and web_frontend commit in its template repository, following the commands in the issue. Done when both release and RC procedures cover this and the next release creates the specified tags in both repositories.
Written by the indexing model from the issue text.
Description
Problem
Each OpenRVDAS release tag pins exact commits of the web_backend (OceanDataTools/fastapi-template) and web_frontend (OceanDataTools/vite-react-template) submodules. Those repos sync their openrvdas branches to new template releases by rebasing openrvdas_dev and force-moving openrvdas (fastapi-template#56/#57, vite-react-template#114). After a sync, the commits a release pinned can sit on no branch or tag in the submodule repo.
GitHub still serves such a commit by SHA for a while, but nothing guarantees it. Once one is garbage-collected, a fresh clone of that release fails at git submodule update.
This has already happened. Backend commits pinned by v2.7.0 / v2.7.0rc9 / v2.7.1 (5f5ae19) and v2.7.0rc4–rc8 (5ee7475) were orphaned by earlier syncs. They were recovered and tagged on 2026-11-18, together with the v2.7.2 pins, which the latest sync would have orphaned:
| Repo | Tag | Commit | Pinned by |
|---|---|---|---|
| fastapi-template | openrvdas-v2.7.2-pin |
9933bb6 | v2.7.2 |
| fastapi-template | openrvdas-v2.7.1-pin |
5f5ae19 | v2.7.0, v2.7.0rc9, v2.7.1 |
| fastapi-template | openrvdas-v2.7.0rc8-pin |
5ee7475 | v2.7.0rc4–rc8 |
| vite-react-template | openrvdas-v2.7.2-pin |
5c757ce | v2.7.0, v2.7.0rc9, v2.7.1, v2.7.2 |
| vite-react-template | openrvdas-v2.7.0rc8-pin |
23ddd1c | v2.7.0rc4–rc8 |
All 70 current OpenRVDAS tags now have their submodule commits on a branch or tag. The template repos' sync procedure now checks for this before every force-push (fastapi-template#58, vite-react-template#115), but that check is a safety net. The pin should be protected when it's created.
Proposal
1. RELEASING.md: add a step after "3. Tag the merge commit", and the same for release candidates:
VERSION=v2.7.3
for sub in web_backend web_frontend; do
sha=$(git ls-tree "$VERSION" "$sub" | awk '{print $3}')
git -C "$sub" fetch origin
git -C "$sub" tag -a "openrvdas-$VERSION" "$sha" -m "$sub commit pinned by OpenRVDAS $VERSION"
git -C "$sub" push origin "openrvdas-$VERSION"
done
This needs push access to both template repos, which the maintainers already have. The tags live in the template repos, so they can't affect OpenRVDAS's own git describe / setuptools_scm version, which reads only this repo's tree (logger/utils/read_version.py).
2. Optional CI check (read-only, like the Release Tags workflow): on each release tag, and on pushes to dev that move a submodule pointer, confirm the pinned commit is contained in a branch or tag of its submodule repo. A fully automated tag push from Actions would need a token with write access to the other repos, so the manual step plus a read-only check is probably simpler.
3. Optional consistency: once this is in place, the ad hoc -pin tags above could be renamed to the openrvdas-vX.Y.Z form (one tag per pinning release), or left as they are.
Acceptance
- RELEASING.md covers tagging submodule commits for releases and release candidates.
- The next release (or RC) creates
openrvdas-<version>tags in both template repos.
- Dominant language
- Python
- Stars
- 57
- Forks
- 30
- Avg merge
- 3h 14m
- Merged PRs (30d)
- 56
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the 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 OceanDataTools/openrvdas
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
OceanDataTools/openrvdas#758 · 1 comment ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
OceanDataTools/openrvdas#748 · 1 comment ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 58/100
OceanDataTools/openrvdas#743 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
OceanDataTools/openrvdas#721 ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 54/100
OceanDataTools/openrvdas#717 ·
Maintainers usually reply within 1 day
All issues in OceanDataTools/openrvdas
Similar issues
-
automated endpoint-dead needs-curation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
almanac-data/climate-almanac#138 ·
Maintainers usually reply within 1 day
-
level/subtask type/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
wazuh/wazuh-virtual-machines#1091 ·
Maintainers usually reply within 1 day
-
Python: Bug: ChatMessageContent.from_element drops AudioContent and BinaryContent into raw TextContentPossibly taken @halcyon-past claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
microsoft/semantic-kernel#14824 · 1 comment ·
Maintainers usually reply within 3 days
-
help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
stack314/django-neolith#142 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
LedgerHQ/app-bitcoin-legacy#306 ·