docs: trigger the docs-pages workflow on release branches#17281
docs: trigger the docs-pages workflow on release branches#17281denesb merged 2 commits intoscylladb:nextfrom
Conversation
|
Looks good. |
|
It won't work. When a |
@benipeled To sum up, we specify which branches we want to publish in I think we need to close this PR, but we'll queue scylladb/sphinx-scylladb-theme#886 to improve the current solution. |
If we have one This way the pages will always be built from the default branch even when they'll trigger from another branch |
|
Sounds good to me, but I need to defer to @dgarcia360. |
@benipeled looks good. I'm testing the proposed solution in scylladb/sphinx-scylladb-theme#1023 If it works, could you please update this PR? |
beec69f to
c06282b
Compare
Done PS> I like the |
Currently, the github docs-pages workflow is triggered only when changes are merged to the master/enterprise branches, which means that in the case of changes to a release branch, for example, a fix to branch-5.4, or a branch-5.4>branch-2024.1 merge, the docs-pages is not triggering and therefore the documentation is not updated with the new change, In this change, I added the `branch-**` pattern, so changes to release branches will trigger the workflow.
In order to publish the docs-pages from release branches (see the other commit), we need to make sure that docs is always built from the default branch which contains the updated conf.py Ref scylladb#17281
|
@benipeled LGTM. We tested the solution in sphinx-scylladb-theme and triggered a build from a branch: https://github.com/scylladb/sphinx-scylladb-theme/actions/runs/8154359635 |
|
@scylladb/scylla-maint please merge |
|
@benipeled in the future, please use |
Why? is it effect somehow the merge script? |
In order to publish the docs-pages from release branches (see the other commit), we need to make sure that docs is always built from the default branch which contains the updated conf.py Ref scylladb#17281
Currently, the github docs-pages workflow is triggered only when changes are merged to the master/enterprise branches, which means that in the case of changes to a release branch, for example, a fix to branch-5.4, or a branch-5.4>branch-2024.1 merge, the docs-pages is not triggering and therefore the documentation is not updated with the new change,
In this change, I added the
branch-**pattern, so changes to release branches will trigger the workflow