miraclx/freyr-js

Use trunk version in the git repo

Open

#352 aberto em 19 de set. de 2022

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (2.279 stars) (154 forks)user submission
enhancementgood first issue

Description

It's hard to distinguish between a version of freyr installed from the package registries or one run from github. Would be useful to have the git revision in the freyr header for more helpful debugging.

Guia do colaborador

Pilha de tecnologia
javascriptnodejs
Domain
clideveloper experiencetooling
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Node.js basicsGit basicsUnderstanding of package.json version field
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65
Direção de pesquisa
Look at the existing build process in package.json and scripts (e.g., build script, version command). Investigate how the current version string is generated (likely from package.json). Then, integrate `git describe tags` or `git rev parse HEAD` during build to embed the commit hash into the CLI header. Check if there's a build step that sets a global constant or reads a file. The issue suggests modifying the header output to include the revision. Consider using a prebuild step to generate a version.ts file with the hash.