diff --git a/README.md b/README.md index 77035e701..b815046fa 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,7 @@ for information on how to submit those. ## Resources -The tpm2-tools wiki: - +Reference the tutorials at [tpm2-software.github.io](https://tpm2-software.github.io). TPM 2.0 specifications can be found at [Trusted Computing Group](http://www.trustedcomputinggroup.org/). diff --git a/doc/INSTALL.md b/doc/INSTALL.md index 816177ecf..b23b8d614 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -106,7 +106,7 @@ $ sudo dnf builddep tpm2-tools The package installed above contains all the dependencies for tpm2-tools included the projects mentioned at the beginning of this section (tpm2-tss and tpm2-abrmd) For more detailed information about the dependencies of tpm2-tss and tmp2-abrmd, please consult the corresponding links for each project. You can find these links in -the [Dependency-Matrix](https://github.com/tpm2-software/tpm2-tools/wiki/Dependency-Matrix) +the [Dependency-Matrix](https://tpm2-software.github.io/versions/) ## Building diff --git a/doc/RELEASE.md b/doc/RELEASE.md index d6eac01e9..e2c72a67e 100644 --- a/doc/RELEASE.md +++ b/doc/RELEASE.md @@ -1,3 +1,35 @@ +# Release Lifecycle + +All tpm2-tools project releases before 4.0 is considered legacy and is or will +be reaching end of life. Releases greater than 4.0 will always +**will be backwards compatible**. Thus, based on the semver.org rules outlined, +pretty much dictates we will never be off of a 4.X version number. Because of +this, master will always be the *next* release, and bugfix only releases can be +branched off of *master* as needed. These patch level branches will be supported +on an as needed bases, since we don't have dedicated stable maintainers. The +majority of development will occur on *master* with tagged release numbers +following semver.org recommendations. This page explicitly does not formalize an +LTS support timeline, and that is intentional. The release schedules and +required features are driven by community involvement and needs. However, +milestones will be created to outline the goals, bugs, issues and timelines of +the next release. + +## End Of Life versions +- [1.X](https://github.com/tpm2-software/tpm2-tools/tree/1.X) +- [2.X](https://github.com/tpm2-software/tpm2-tools/tree/2.X) +- [3.0.X](https://github.com/tpm2-software/tpm2-tools/tree/3.0.X) + +## Near End of Life +- [3.0.X](https://github.com/tpm2-software/tpm2-tools/tree/3.0.X): EOL after +3.2.1 release. + +## OpenSSL + +tpm2-tools relies heavily on OpenSSL. OpenSSL will be EOL'ing 1.0.2 at the end +of 2019, see: https://www.openssl.org/blog/blog/2018/05/18/new-lts/. When this +occurs, we will remove OSSL 1.0.2 support from the tpm2-tools repository as +supporting an EOL crypto library is not a good idea. + # Release Information Releases shall be tagged following semantic version guidelines found at: @@ -99,7 +131,8 @@ The steps, in order, required to make a release. that release as the message for the GitHub release. **Add the dist tarball and signature file to the release**. -- Update the version matrix in the wiki ensuring that the CI is building against a released version of: +- Update the [dependency-matrix](https://tpm2-software.github.io/versions/) + ensuring that the CI is building against a released version of: - [tpm2-abrmd](https://github.com/tpm2-software/tpm2-abrmd) - [tpm2-tss](https://github.com/tpm2-software/tpm2-tss)