Update --validator-keys docs - #780
alexandratran merged 1 commit into
Conversation
|
@Matilda-Clerke is attempting to deploy a commit to the Consensys Team on Vercel. A member of the Team first needs to authorize it. |
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
|
can we hold off this merge until 26.8.0 is released so the documentation is consistent? |
The Teku docs are versioned, so this change would only apply in the "Development" tab in the docs (until next release), which doesn't display by default and includes a banner that some documented features are not yet available in the stable release. Docs versioning is useful for this exact case where we publish documentation for unreleased features. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
606bbe5
into
Consensys-Incorporated:main
yes the point was we're hours from finishing the release and this is not in the release. |
Our pipeline automatically handles documentation versioning, so anything merged into the docs is released with the next version (in this case, 26.8.0). We try to have all teku changes readily available, but this time, because of a longer soaking period, we ended up with a feature that is merged in Teku, but missed our release cycle. We need to revert this change and re-merge it after we release the docs. I'll have a PR for it shortly. |
|
Created https://github.com/Consensys/teku-internal/issues/313 to capture this "timing" issue and potentially fix this for future releases. |
Docs changes relating to Consensys-Incorporated/teku#10990
Note
Low Risk
Documentation-only change to the CLI reference; no runtime or validator key-loading behavior is modified in this diff.
Overview
Updates the
--validator-keysCLI reference to document a third pairing form: keystore directory plus a single password file (KEY_DIR:PASS_FILE), alongside the existing directory:directory and file:file forms.The syntax line and a new tab example show using one
.txtpassword for every.jsonkeystore in a keys directory. The directory-mode explanation now states that matching per-validator password filenames are expected unless a specific password file is given, in which case that file applies to all keystores in the directory.Reviewed by Cursor Bugbot for commit b62f138. Bugbot is set up for automated code reviews on this repo. Configure here.