Skip to content

Commit

Permalink
Merge pull request #5 from gittuf/prepare-for-release
Browse files Browse the repository at this point in the history
Update alpha status and minimum Go version
  • Loading branch information
adityasaky authored Oct 26, 2023
2 parents 0d30b0f + bb6d492 commit bcbc699
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
2 changes: 1 addition & 1 deletion contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ from Git users if they believe gittuf's design is not compatible with their
workflows. Please file an issue on the [gittuf repository] to get started!


[code of conduct]: https://github.com/gittuf/gittuf/blob/main/CODE-OF-CONDUCT.md
[code of conduct]: https://github.com/gittuf/community/blob/main/CODE-OF-CONDUCT.md
[contributing guide]: https://github.com/gittuf/gittuf/blob/main/CONTRIBUTING.md
[gittuf repository]: https://github.com/gittuf/gittuf
[design document]: https://github.com/gittuf/gittuf/blob/main/docs/specification.md
24 changes: 13 additions & 11 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,20 @@ as part of the [Supply Chain Integrity Working Group].

## Current Status

gittuf is currently in an early-development stage and is therefore considered
pre-alpha. Please do not use it in a production system or repository.
gittuf is currently in alpha. Please do not use it in a production system or
repository.

## Installation

gittuf requires Go 1.20 or higher.
The [gittuf repository] provides pre-built binaries that are signed and
published using [GoReleaser]. The signature for these binaries are generated
using [Sigstore], using the release workflow's identity. Please use release
v0.1.0 or higher, as prior releases were created to test the release workflow.
Alternatively, gittuf can also be installed using `go install`.

The tool can be installed using `go install` as follows:

```bash
$ go install github.com/gittuf/gittuf@latest
```

Alternatively, you can clone the repository and run `make`. This will also run
the test suite prior to installing gittuf.
To build from source, clone the repository and run `make``. This will also run
the test suite prior to installing gittuf. Note that Go 1.21 or higher is
necessary to build gittuf.

```bash
$ git clone https://github.com/gittuf/gittuf
Expand All @@ -42,3 +41,6 @@ $ make
[other attacks]: https://ssl.engineering.nyu.edu/papers/torres_toto_usenixsec-2016.pdf
[Open Source Security Foundation (OpenSSF)]: https://openssf.org/
[Supply Chain Integrity Working Group]: https://github.com/ossf/wg-supply-chain-integrity
[gittuf repository]: https://github.com/gittuf/gittuf
[GoReleaser]: https://goreleaser.com/
[Sigstore]: https://www.sigstore.dev/

0 comments on commit bcbc699

Please sign in to comment.