docs: describe build process #109
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
G-Rath
reviewed
Jan 2, 2023
README.md
Outdated
| @@ -59,6 +59,13 @@ $ go install github.com/google/osv-scanner/cmd/osv-scanner@v1 | |||
|
|
|||
| This requires Go 1.18+ to be installed. | |||
|
|
|||
| ### Releasing | |||
There was a problem hiding this comment.
I think it would be better to title this "Building", and frame it from that POV - so start with explaining that you can build from source using goreleaser build --single-target, and then mention that version builds can be reproduced by checking out the specific tag and doing a build.
Is probably also worth linking to the goreleaser build docs
G-Rath
approved these changes
Jan 2, 2023
oliverchang
approved these changes
Jan 6, 2023
Co-authored-by: Gareth Jones <Jones258@Gmail.com>
jfhovinne
force-pushed
the
docs-releasing
branch
from
963d1e8
to
d7b2eb3
Compare
|
/gcbrun |
julieqiu
pushed a commit
to julieqiu/osv-scanner
that referenced
this pull request
May 2, 2023
* docs: describe release process * docs: describe build process * docs: typo Co-authored-by: Gareth Jones <Jones258@Gmail.com> Co-authored-by: Gareth Jones <Jones258@Gmail.com> Co-authored-by: Rex P <106129829+another-rex@users.noreply.github.com>
julieqiu
pushed a commit
to julieqiu/osv-scanner
that referenced
this pull request
May 2, 2023
* docs: describe release process * docs: describe build process * docs: typo Co-authored-by: Gareth Jones <Jones258@Gmail.com> Co-authored-by: Gareth Jones <Jones258@Gmail.com> Co-authored-by: Rex P <106129829+another-rex@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I would suggest to document the release process, and in particular how to reproduce the builds locally.