Skip to content

Commit

Permalink
#64: Document workaround using a remote branch for tags
Browse files Browse the repository at this point in the history
  • Loading branch information
mtkennerly committed Jun 5, 2023
1 parent 3e00ba3 commit 0375d0d
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,12 @@ prompted the creation of Dunamai as an alternative:
## Other notes
* Dunamai needs access to the full version history to find tags and compute distance.
Be careful if your CI system does a shallow clone by default.

* For GitHub workflows, invoke `actions/checkout@v3` with `fetch-depth: 0`.
* For GitLab pipelines, set the `GIT_DEPTH` variable to 0.

For Git, you can also avoid doing a full clone by specifying a remote branch for tags
(e.g., `--tag-branch remotes/origin/master`).
* When using Git, remember that lightweight tags do not store their creation time.
Therefore, if a commit has multiple lightweight tags,
we cannot reliably determine which one should be considered the newest.
Expand Down

0 comments on commit 0375d0d

Please sign in to comment.