[RFC] providing git-describe alike metadata in a env var
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 8.9k
- Forks
- 2.8k
- PR merge metrics
- No merged PRs in 30d
Description
With tools that use scm metadata to guess the current/next version, the setup of fetching only one commit and no tags, basically implies that the tools have to fetch tags/commits in order to be able to provide metadata again
if the checkout action could provide that metadata in a env var by a opt/in/extra list of options, it could spare that expensive check.
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
Review the checkout action's shallow-fetch behavior and how it currently exposes environment variables. Define which git-describe-like metadata and opt-in options are needed, then verify that consumers can use the metadata without fetching additional tags or commits.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github-actions, typescript
- Domain
- ci-cd
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100