Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Zipfile build displays a blank version number #46

Open
pinobatch opened this issue Mar 21, 2023 · 0 comments
Open

Zipfile build displays a blank version number #46

pinobatch opened this issue Mar 21, 2023 · 0 comments

Comments

@pinobatch
Copy link
Owner

pinobatch commented Mar 21, 2023

In 240p Test Suite v0.23, I added a feature to automatically display a build identifier generated using git describe --tags. Most of the work was done around commit c056e59, in turn based on the work I did for the same feature in Holy Mapperel.

git describe --tags | tr -d '\r\n' > obj/nes/last-commit-now`

When Git cannot find an appropriate tag, this produces a blank file. This can happen when building 240p Test Suite in three situations: from a zipfile, from a shallow clone, or (a decade or two from now) once the maintainer has migrated to a VCS other than Git. This leads to a blank version number on the Credits screen. Currently we avoid a blank version number in GitHub Actions builds by avoiding a shallow clone (#45).

A user of the gbadev Discord server has characterized reliance on git describe --tags to display a version number as "a bug in your build process. My NDS SDK can detect if it isn't building in a git repo, and it doesn't try to use git describe." How can we provide a useful version number for a copy of 240p Test Suite built from a zipfile without adding yet another manual step to release_checklist.md and renumbering all steps that come after it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant