Skip to content

ci: support versioned documentation directories and fix timestamp-only check - #55

Merged
KazuCocoa merged 2 commits into
appium:masterfrom
hoanle0126:feat-versioned-docs-workflow-23
Oct 27, 2026
Merged

KazuCocoa merged 2 commits into
appium:masterfrom
hoanle0126:feat-versioned-docs-workflow-23

Conversation

@hoanle0126

Copy link
Copy Markdown
Contributor

Update .github/workflows/pythonpackage.yml to:

  1. Support building and publishing versioned documentation under docs/v<major>.<minor>/ (e.g., docs/v6.0/) and docs/latest/ alongside the root docs/ directory without wiping out previously built docs/v* subdirectories.
  2. Add an optional ref input to workflow_dispatch so documentation can also be generated for specific appium/python-client release tags or branches.
  3. Sync conf.py's project and release version strings from pyproject.toml before running generate.sh, and include $HOME/.local/bin in PATH when make install-uv installs uv.
  4. Revert *_sources/index.rst.txt when the only diff is the sphinx-quickstart on ... timestamp line instead of running exit 1 (which previously caused scheduled runs to fail whenever docs/_sources/index.rst.txt | 2 +- appeared in git diff --stat, even when other files also changed).

Fixes #23

@hoanle0126
hoanle0126 requested a review from KazuCocoa as a code owner October 26, 2026 03:47
@KazuCocoa

Copy link
Copy Markdown
Member

Could you create scripts and call them from the yaml rather than put all in the yaml?

@hoanle0126

Copy link
Copy Markdown
Contributor Author

Extracted the conf.py version sync and documentation directory update steps into scripts/sync_conf_version.py and scripts/update_docs.sh and called them from .github/workflows/pythonpackage.yml. Thanks @KazuCocoa!

@KazuCocoa KazuCocoa left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lg. I'll do a small modifications as a followup

@KazuCocoa
KazuCocoa merged commit 2c8f640 into appium:master Oct 27, 2026
1 check passed
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.

Versioning for docs

2 participants