Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(conf.py): do not include git hash in docs for version-tagged commits #87

Merged
merged 1 commit into from
Jan 11, 2025

Conversation

yxlao
Copy link
Owner

@yxlao yxlao commented Jan 11, 2025

  • When the current commit is tagged as version v{major}.{minor}.{patch}, the docs version is set to v{major}.{minor}.{patch}, e.g. v1.0.0.
  • Otherwise, the docs version is set to v{major}.{minor}.{patch}+{git_hash}, e.g. v1.0.0+abc123.

@yxlao yxlao force-pushed the yixing/docs-tagged-version branch 3 times, most recently from 2d33867 to 22d9764 Compare January 11, 2025 12:14
…en version-tagged and untagged commits

The commit improves the version detection mechanism in the documentation configuration. It now checks if the current commit is tagged with a version and uses the version number directly for tagged commits. For untagged commits, it appends the git hash to the version number. This ensures more accurate versioning in the documentation build process.
@yxlao yxlao force-pushed the yixing/docs-tagged-version branch from 22d9764 to 07b38a9 Compare January 11, 2025 12:15
@yxlao yxlao changed the title docs(conf.py): improve docs version logic for tagged and untagged commits docs(conf.py): do not include git hash in docs for version-tagged commits Jan 11, 2025
@yxlao yxlao merged commit edf7995 into main Jan 11, 2025
10 checks passed
@yxlao yxlao deleted the yixing/docs-tagged-version branch January 11, 2025 12:22
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.

1 participant