mapbox / mapbox/mapbox-directions-swift
publish-documentation.sh clobbers local clone
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 206
- Forks
- 99
- Avg merge
- 7h 54m
- Merged PRs (30d)
- 3
Description
publish-documentation.sh prunes branches and hollows out the clone into a shallow clone:
https://github.com/mapbox/mapbox-directions-swift/blob/871940cf996cfa9241f5afc945911d53260b4b75/scripts/publish-documentation.sh#L17
This is very inconvenient for the development team, forcing us to reclone the repository every time we publish documentation (or avoid the script, which doesn’t do much in the first place).
Thanks to @S2Ler for the suggestion.
/ref #467
/cc @mapbox/navigation-ios
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at scripts/publish-documentation.sh line 17 and inspect the branch-pruning and shallow-clone behavior described in the issue. Verify that publishing documentation no longer clobbers the existing local clone, then run the script or a focused manual workflow to confirm the clone remains usable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, shell
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100