Repository navigation
Conversation
larrybabb
left a comment
There was a problem hiding this comment.
Thanks. Pointing docs at v3 for now makes sense. One thing will keep this from working as intended, though:
Pushes to v3 will build the docs but never publish them. The publish job (line 44, outside the diff) still requires main:
publish:
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref_type == 'tag')After merge, a push to v3 has github.ref == 'refs/heads/v3', so build runs, publish is skipped, and https://ga4gh.github.io/vrs-python/ isn't updated.
Suggested fix: the push.branches filter already limits which branches start the workflow, so the job condition doesn't need to name the branch again:
publish:
if: github.event_name == 'push' && (github.ref_type == 'branch' || github.ref_type == 'tag')That keeps the trigger as the single place that names the branch, so switching back to main later is a one-line change and the two copies can't drift apart again. (The deploy step already branches on GIT_REF_TYPE, so it needs no change.)
There's no Python here to unit test. After merge, it would be worth confirming the first v3 push shows the publish job running (not skipped) in Actions and that latest on gh-pages updates.
| push: | ||
| branches: | ||
| - main | ||
| - v3 |
There was a problem hiding this comment.
This trigger change needs a matching change to the publish job's if: (line 44), which still checks refs/heads/main. Otherwise v3 pushes skip publishing. See the summary for a suggested condition that doesn't repeat the branch name.
larrybabb
left a comment
There was a problem hiding this comment.
A couple of optional notes. They don't block the PR.
Default docs will track unreleased code. Once publishing from v3 works, every v3 push runs mike deploy --push latest and mike set-default --push latest (lines 84–85), so the site's default docs will show v3 APIs that aren't on PyPI yet. That's probably fine for the transition, but worth doing deliberately. If it's a concern, deploying v3 under its own alias (e.g. mike deploy --push dev) and leaving latest / the default on the last release would avoid it.
| push: | ||
| branches: | ||
| - main | ||
| - v3 |
There was a problem hiding this comment.
Optional: since this is marked temporary and the PR body is empty, a short comment here (e.g. # TODO: switch back to main when v3 is merged) or a linked tracking issue would help. If v3 is merged into main with this line unchanged, pushes to main will stop triggering the docs workflow entirely.
No description provided.