AlCalzone / release-script

Painless release management for Node.js projects
MIT License
14 stars 10 forks source link

Consistency around version 'v' prefix #134

Open raintonr opened 1 year ago

raintonr commented 1 year ago

I note that version numbers are not prefixed with 'v':

So could this release script be changed to please not prefix 'v' on git tags and the messages it creates in README.md (and anwhere else I probably didn't notice).

Consistency is always best.

AlCalzone commented 1 year ago

Agree with the point about consistency, but I think it's practical to have all versioned tags grouped in git: grafik

In addition, the release workflow uses this prefix to determine which tags to build: https://github.com/ioBroker/create-adapter/blob/b31a28951d70f2ba2166ee7189a065a2044da66d/test/baselines/adapter_JS_ES6Class_ESLint_TypeChecking_Spaces_SingleQuotes_Apache-2.0/.github/workflows/test-and-release.yml#L9-L13 and to release: https://github.com/ioBroker/create-adapter/blob/b31a28951d70f2ba2166ee7189a065a2044da66d/test/baselines/adapter_JS_ES6Class_ESLint_TypeChecking_Spaces_SingleQuotes_Apache-2.0/.github/workflows/test-and-release.yml#L66

Changing this prefix would mean that matching these tags becomes much harder (granted the current check is not 100% foolproof).