ref: Log descriptive error message when no tags are found during release preparation #617
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
asottile-sentry
approved these changes
Sep 4, 2025
src/utils/git.ts
Outdated
| return (await git.raw('describe', '--tags', '--abbrev=0')).trim(); | ||
| } catch (e) { | ||
| logger.error( | ||
| "Couldn't get the latest tag! If you're releasing for the first time, check if your repo contains any tags. If not, add one manually and try again." |
There was a problem hiding this comment.
perhaps even include the command here? git tag 0.0.0 "$(git log -1 --reverse --format=%h)"
|
#602 would make this redundant, right? @asottile-sentry? |
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.
A common pitfall when first setting up craft and our publishing workflow in a new repo is that there's no tag yet in this repo. While this is mentioned as a step in the develop docs, it happens often enough that we don't do it and end up with a less than helpful error in the release preparation flow. This PR simply adds a more descriptive error message so that users have a better idea what to do.