Skip to content

Adjust release workflow for new "v"-prefixed tag format #111

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

Merged
merged 1 commit into from
Mar 21, 2022
Merged

Adjust release workflow for new "v"-prefixed tag format #111

merged 1 commit into from
Mar 21, 2022

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Mar 21, 2022

The Go modules system requires the release Git tags to start with a "v" prefix. Historically, this project has used the otherwise more sensible approach of using the exact version number as a tag name.

This meant that the module could only be used as a dependency via "pseudo-versions".

For example, go get github.com/arduino/libraries-repository-engine@latest currently adds this travesty to your
go.mod file:

require github.com/arduino/libraries-repository-engine v0.0.0-20220321045648-4999750bf965

This causes several problems:

  • Unstable non-release versions of the module are more likely to be used by dependent projects
  • Automated release update services (i.e., Dependabot) are not available, resulting in dependent projects using outdated versions of the module

The release workflow was configured for the previous non-prefixed tag format, so it must be adjusted for the new "v" prefixed tag format.

The Go modules system requires the release Git tags to start with a "v" prefix. Historically, this project has used the
otherwise more sensible approach of using the exact version number as a tag name.

This meant that the module could only be used as a dependency via "pseudo-versions".

For example, `go get github.com/arduino/libraries-repository-engine@latest` currently adds this travesty to your
`go.mod` file:

```text
require github.com/arduino/libraries-repository-engine v0.0.0-20220321045648-4999750bf965
```

This causes several problems:

- Unstable non-release versions of the module are more likely to be used by dependent projects
- Automated release update services (i.e., Dependabot) are not available, resulting in dependent projects using outdated
  versions of the module

The release workflow was configured for the previous non-prefixed tag format, so it must be adjusted for the new "v"
prefixed tag format.
@per1234 per1234 requested a review from umbynos March 21, 2022 11:12
@per1234 per1234 self-assigned this Mar 21, 2022
@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Mar 21, 2022
@per1234 per1234 merged commit 3fa2ef6 into arduino:main Mar 21, 2022
@per1234 per1234 deleted the tag-prefix branch March 21, 2022 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants