Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: prerelease doc and CHANGELOG updates for Go builder #1830

Merged
merged 4 commits into from
Mar 16, 2023
Merged

docs: prerelease doc and CHANGELOG updates for Go builder #1830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
df8f9bb
update
laurentsimon Mar 16, 2023
617173d
update
laurentsimon Mar 16, 2023
ff682a7
update
laurentsimon Mar 16, 2023
29429ef
update
laurentsimon Mar 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/builder_go_slsa3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,7 @@ jobs:
if: inputs.upload-tag-name != ''
with:
tag_name: "${{ inputs.upload-tag-name }}"
prerelease: ${{ inputs.prerelease }}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOTE: updated because the Action code updates the prerelease tag in all cases https://github.com/softprops/action-gh-release/blob/master/src/github.ts#L259

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I had assumed in doing the review that it would preserve this. Great check.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just in case...

files: |
${{ needs.build-dry.outputs.go-binary-name }}
${{ needs.provenance.outputs.go-provenance-name }}
43 changes: 38 additions & 5 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,23 @@

<!-- toc -->

- [v1.5.0](#v150)
- [v1.6.0](#v160)
- [Summary of changes](#summary-of-changes)
- [Go builder](#go-builder)
- [New Features](#new-features)
- [Generic generator](#generic-generator)
- [New Features](#new-features-1)
- [Container generator](#container-generator)
- [New Features](#new-features-2)
- [Changelog since v1.5.0](#changelog-since-v150)
- [v1.5.0](#v150)
- [Summary of changes](#summary-of-changes-1)
- [Go builder](#go-builder-1)
- [New Features](#new-features-3)
- [Generic generator](#generic-generator-1)
- [New Features](#new-features-4)
- [Container generator](#container-generator-1)
- [New Features](#new-features-5)
- [Changelog since v1.4.0](#changelog-since-v140)
- [v1.4.0](#v140)
- [What's Changed](#whats-changed)
Expand Down Expand Up @@ -37,18 +46,18 @@
- [Full Changelog](#full-changelog-4)
- [v1.2.1](#v121)
- [What's Changed](#whats-changed-5)
- [Generic generator](#generic-generator-1)
- [Generic generator](#generic-generator-2)
- [buildType](#buildtype)
- [Provenance file names](#provenance-file-names)
- [Explicit opt-in for private repos](#explicit-opt-in-for-private-repos)
- [Go builder](#go-builder-1)
- [Go builder](#go-builder-2)
- [Support private repos](#support-private-repos)
- [New Contributors](#new-contributors-5)
- [Full Changelog](#full-changelog-5)
- [v1.2.0](#v120)
- [What's Changed](#whats-changed-6)
- [Generic generator](#generic-generator-2)
- [Go builder](#go-builder-2)
- [Generic generator](#generic-generator-3)
- [Go builder](#go-builder-3)
- [New Contributors](#new-contributors-6)
- [Full Changelog](#full-changelog-6)
- [v1.1.1](#v111)
Expand All @@ -61,6 +70,30 @@

<!-- tocstop -->

<!-- Information on the next release will be added here. -->

# v1.6.0

## Summary of changes

### Go builder

#### New Features

- A new [`prerelease`](https://github.com/slsa-framework/slsa-github-generator/blob/v1.6.0/internal/builders/generic/README.md#workflow-inputs) input was added to allow users to create releases marked as prerelease when `upload-assets` is set to `true`.

### Generic generator

#### New Features

### Container generator

#### New Features

## Changelog since v1.5.0

https://github.com/slsa-framework/slsa-github-generator/compare/todo...v1.5.0

# v1.5.0

<!-- Information on the next release will be added here. -->
Expand Down
1 change: 1 addition & 0 deletions internal/builders/go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ The builder workflow [slsa-framework/slsa-github-generator/.github/workflows/bui
| `go-version` | yes | | The go version for your project. This value is passed, unchanged, to the [actions/setup-go](https://github.com/actions/setup-go) action when setting up the environment |
| `upload-assets` | no | true on new tags | Whether to upload assets to a GitHub release or not. |
| `upload-tag-name` | no | | If specified and `upload-assets` is set to true, the provenance will be uploaded to a Github release identified by the tag-name regardless of the triggering event. |
| `prerelease` | no | | If specified and `upload-assets` is set to true, the release is created as prerelease.
| `private-repository` | no | false | Set to true to opt-in to posting to the public transparency log. Will generate an error if false for private repositories. This input has no effect for public repositories. See [Private Repositories](#private-repositories). |

### Workflow Example
Expand Down