Skip to content

Commit

Permalink
chore: Amend readme text before release (#3402)
Browse files Browse the repository at this point in the history
# Summary

Amend readme text before release

## Testing Process

...

## Checklist

- [ ] Review the contributing [guidelines](./../CONTRIBUTING.md)
- [ ] Add a reference to related issues in the PR description.
- [ ] Update documentation if applicable.
- [ ] Add unit tests if applicable.
- [ ] Add changes to the [CHANGELOG](./../CHANGELOG.md) if applicable.

Signed-off-by: laurentsimon <laurentsimon@google.com>
  • Loading branch information
laurentsimon authored Mar 21, 2024
1 parent 2cf77fa commit 6ff2c75
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 10 deletions.
25 changes: 17 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

<!-- toc -->

- [Unreleased](#unreleased)
- [Unreleased: Gradle Builder](#unreleased-gradle-builder)
- [Unreleased: Go Builder](#unreleased-go-builder)
- [Unreleased: Container Generator](#unreleased-container-generator)
- [v1.10.0](#v1100)
- [v1.10.0: TUF fix](#v1100-tuf-fix)
- [v1.10.0: Gradle Builder](#v1100-gradle-builder)
- [v1.10.0: Go Builder](#v1100-go-builder)
- [v1.10.0: Container Generator](#v1100-container-generator)
- [v1.9.0](#v190)
- [v1.9.0: BYOB framework (beta)](#v190-byob-framework-beta)
- [v1.9.0: Maven builder (beta)](#v190-maven-builder-beta)
Expand Down Expand Up @@ -97,19 +98,27 @@ Use the format "X.Y.Z: Go builder" etc. for format headers to avoid header name
duplication."
-->

## Unreleased
## v1.10.0

### Unreleased: Gradle Builder
Release [v1.10.0] includes bug fixes and new features.

See the [full change list](https://github.com/slsa-framework/slsa-github-generator/compare/v1.9.0...v1.10.0).

### v1.10.0: TUF fix

- The cosign TUF roots were fixed (#3350). More details [here](https://github.com/slsa-framework/slsa-github-generator/blob/v1.10.0/README.md#error-updating-to-tuf-remote-mirror-invalid).

### v1.10.0: Gradle Builder

- The Gradle Builder was fixed when the project root is the same as the
repository root (#2727)

### Unreleased: Go Builder
### v1.10.0: Go Builder

- The `go-version-file` input was fixed so that it can find the `go.mod` file
(#2661)

### Unreleased: Container Generator
### v1.10.0: Container Generator

- A new `provenance-repository` input was added to allow reading provenance from
a different container repository than the image itself (#2956)
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,15 +205,15 @@ A command line example is provided in [slsa-framework/slsa-verifier#example](htt

### error updating to TUF remote mirror: invalid

This will occur only when generating provenance with all builders and generators.
This will occur when generating provenance with all builders and generators.

**Affected versions:** all versions up and including v1.9.0

```shell
error updating to TUF remote mirror: invalid
```

This issue is tracked by [issue #3350](https://github.com/slsa-framework/slsa-github-generator/issues/3350). You _must_ update to the newest patch versions of each minor release to fix this issue.
This issue is tracked by [issue #3350](https://github.com/slsa-framework/slsa-github-generator/issues/3350). You _must_ update to v1.10.0 to fix this issue.

## Build Your Own Builder

Expand Down

0 comments on commit 6ff2c75

Please sign in to comment.