Document shallow clones in CI and RTD #126
Merged
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates CI and documentation build configurations to use shallow clones with a depth of 256 commits instead of fetching full repository history. This change optimizes build performance while maintaining enough history to access recent release tags for version number generation. Additionally, the PR removes several development environment configuration files that are no longer needed.
- Changed from full git history (
fetch-depth: 0) to shallow clone with 256 commits in GitHub Actions - Added git fetch configuration in ReadTheDocs to retrieve 256 commits of history
- Removed unused development tool configuration files (.gitattributes, .dir-locals.el, .ackrc)
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| .readthedocs.yaml | Added post_checkout job to fetch 256 commits of git history for version generation |
| .github/workflows/test.yml | Changed from full history to 256-commit shallow clone with explanatory comment |
| .gitattributes | Removed linguist documentation configuration |
| .dir-locals.el | Removed Emacs whitespace cleanup configuration |
| .ackrc | Removed ack search tool ignore patterns |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.