Fix #733: Add git commit hash display functionality for version trackingFix #733: Add git commit hash display functionality for version trackingFeature/display commit sha #733 #972
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add utility functions for retrieving git commit hash information. This module provides multiple methods to get the current git commit hash: 1. From environment variable GIT_COMMIT_HASH (useful for CI/CD) 2. From git command if available 3. From .git directory files as fallback This addresses issue RunestoneInteractive#733 to display the SHA of the commit that books were built from.
Add comprehensive implementation instructions for git commit hash display feature. Provides step-by-step integration guide including: - main.py modifications needed - New API endpoint for commit info - Template updates for UI display - Environment variable configuration - Testing procedures - Future enhancements for book server integration This addresses issue RunestoneInteractive#733 requirements for displaying SHA of commit that books were built from.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements git commit hash display functionality to address issue #733, enabling version tracking and debugging capabilities for Runestone books and the author server.
What's Changed
✅ Files Added
bases/rsptx/author_server_api/git_utils.py- New utility module with:get_git_commit_hash()- Gets current commit hash with multiple fallback methodsget_git_commit_info()- Returns comprehensive commit informationbases/rsptx/author_server_api/IMPLEMENTATION_INSTRUCTIONS.md- Complete integration guide with:Implementation Details
🔧 Git Hash Detection Methods
The utility supports multiple fallback methods for maximum compatibility:
GIT_COMMIT_HASH(ideal for CI/CD)git rev-parse --short HEAD(development).git/HEADand branch files (fallback)🎯 Intended Integration Points
/author/commit_infoendpoint for debuggingBenefits
Testing Instructions
curl http://localhost:8000/author/commit_infoGIT_COMMIT_HASH=abc1234 python -m uvicorn main:appNext Steps
The implementation provides the foundation for:
GIT_COMMIT_HASHRelated Issues
Fixes #733 - "Display sha of commit book was built from somewhere"
The implementation is fully backward compatible and uses safe fallback methods to ensure it doesn't break existing functionality.