search

keycloak / keycloak-benchmark

Keycloak Benchmark
https://www.keycloak.org/keycloak-benchmark/
Apache License 2.0
124 stars 66 forks source link

release docs updated #879

Closed kami619 closed 4 days ago

kami619 commented 5 days ago

fixes #865

kami619 commented 5 days ago

Should we document what version(s) of Keycloak a branch is compatible with in the README file?

Did you mean inside this doc https://github.com/keycloak/keycloak-benchmark/blob/0.13-release/README.adoc for that specific release? We are doing that on the release artifact page currently - https://github.com/keycloak/keycloak-benchmark/releases

ryanemerson commented 5 days ago

I was thinking in the repositories README.adoc so that users can quickly see whether main is applicable to their Keycloak version.

Do we document anywhere that users should use branch xx-release for specific Keycloak versions? I think this would also be nice to have in the README so that users don't try to execute main against an older version etc.

kami619 commented 5 days ago

I was thinking in the repositories README.adoc so that users can quickly see whether main is applicable to their Keycloak version.

Do we document anywhere that users should use branch xx-release for specific Keycloak versions? I think this would also be nice to have in the README so that users don't try to execute main against an older version etc.

Good point, let me think of a way to represent this in the README.adoc of the specific branches, including main.

kami619 commented 5 days ago

I was thinking in the repositories README.adoc so that users can quickly see whether main is applicable to their Keycloak version.

Do we document anywhere that users should use branch xx-release for specific Keycloak versions? I think this would also be nice to have in the README so that users don't try to execute main against an older version etc.

How about we add this to the README.adoc in the main branch? And I can add a comment to update this file as well when a release branch is cut. One task would be to retroactively add this block to all the older release branches.

== Keycloak Compatibility
This `main` branch Keycloak benchmark works with the Keycloak nightly versions,
for specific Keycloak release-based binaries please look at
https://github.com/keycloak/keycloak-benchmark/releases.
ryanemerson commented 4 days ago

That looks great :+1:

One task would be to retroactively add this block to all the older release branches.

IMO most people will read the README on main and then navigate to the required branch from there, so I think we can skip this effort.