Add example for release analytics features #26
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
This commit introduces a new example script `examples/release_analytics.py`. The script demonstrates how to use the `release_tag_summary()` method from `gitpandas.Repository` to get a summary of changes between release tags. This includes diff statistics (insertions, deletions, net changes), files changed, and contributors involved between consecutive tags. The example also briefly shows how `get_commit_content()` can be used to inspect the actual content of a specific commit, such as one a tag points to. Additionally, the new example has been added to the test suite in `tests/test_examples.py` to ensure it runs without errors.
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.
This commit introduces a new example script
examples/release_analytics.py. The script demonstrates how to use therelease_tag_summary()method fromgitpandas.Repositoryto get a summary of changes between release tags. This includes diff statistics (insertions, deletions, net changes), files changed, and contributors involved between consecutive tags.The example also briefly shows how
get_commit_content()can be used to inspect the actual content of a specific commit, such as one a tag points to.Additionally, the new example has been added to the test suite in
tests/test_examples.pyto ensure it runs without errors.Fixes #
Proposed Changes