Fix prerequisites in the documentation#34
Conversation
Fix the prerequisites to reflect the current requirements for Go and add a requirement for nFPM for local builds: * nFPM at least 2.46.0 is required to build msix packages * Go at least version 1.25 is required by nFPM 2.46.0 Signed-off-by: Michael Grymporounis <michail.grymporounis@nokia.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #34 +/- ##
=======================================
Coverage 37.73% 37.73%
=======================================
Files 23 23
Lines 1569 1569
=======================================
Hits 592 592
Misses 917 917
Partials 60 60
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Signed-off-by: Michael Grymporounis <michail.grymporounis@nokia.com>
|
|
||
| ``` | ||
| go install github.com/goreleaser/nfpm/v2/cmd/nfpm@v2.46.0 | ||
| ``` |
There was a problem hiding this comment.
A more extensive description on how to get the binary and install it in a directory in your path is probably required
There was a problem hiding this comment.
No this is fine; although I would prefer to use the tag latest, as in:
$ go install github.com/goreleaser/nfpm/v2/cmd/nfpm@latestAlso, lets try to follow the convention of using bash as the highlighting schema in fenced code blocks that illustrate command line invocations, and prefix them with $. i.e the above should be written as:
```bash
$ go install github.com/goreleaser/nfpm/v2/cmd/nfpm@latest
```
There was a problem hiding this comment.
Changing the tag also changes the Go version it requires, I opted to pin the versions in the prerequisites here, though go install works regardless. As for the prompt, I avoid it because pressing the copy button will not copy just the the command part, so you will need to paste and edit before running it.
There was a problem hiding this comment.
Fixed to follow the convention throughout the README, but please consider if removing the prompt would better facilitate copy-pasting the code block commands.
Please comment if you still want to opt for the latest nFPM version when installing.
migrym
left a comment
migrym
left a comment
There was a problem hiding this comment.
Documentation may need to be further improved.
Building with docker can be controlled with two build args: * ARCH is a space-separated list of architectures to build for * PACKAGE is a space-separated list of package types to build Default ARCH is "amd64 arm64" and PACKAGE is "msix deb rpm osx", allowing for the whole list of supported packages to be built. Specifying different values in the docker build command line allows limiting the scope of the packages to build. Update the README.md file to reflect these changes Signed-off-by: Michael Grymporounis <michail.grymporounis@nokia.com>
Fix a small typo. Ensure all code examples use BASH syntax highlighting and are prefixed by a prompt. Signed-off-by: Michael Grymporounis <michail.grymporounis@nokia.com>
2 participants
Fix the prerequisites to reflect the current requirements for Go and add a requirement for nFPM for local builds: