Skip to content

Update --validator-keys docs - #780

Merged
alexandratran merged 1 commit into
Consensys-Incorporated:mainfrom
Matilda-Clerke:update-validator-keys
Aug 10, 2026
Merged

alexandratran merged 1 commit into
Consensys-Incorporated:mainfrom
Matilda-Clerke:update-validator-keys

Conversation

@Matilda-Clerke

@Matilda-Clerke Matilda-Clerke commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

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-keys CLI 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 .txt password for every .json keystore 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.

@Matilda-Clerke
Matilda-Clerke requested a review from a team as a code owner August 10, 2026 04:34
@vercel

vercel Bot commented Aug 10, 2026

Copy link
Copy Markdown

@Matilda-Clerke is attempting to deploy a commit to the Consensys Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions

github-actions Bot commented Aug 10, 2026

Copy link
Copy Markdown

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@Matilda-Clerke

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Aug 10, 2026
@rolfyone

Copy link
Copy Markdown
Contributor

can we hold off this merge until 26.8.0 is released so the documentation is consistent?

@alexandratran

alexandratran commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

@rolfyone

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.

@vercel

vercel Bot commented Aug 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
doc-teku Ready Ready Preview Aug 10, 2026 9:08pm

Request Review

@alexandratran
alexandratran merged commit 606bbe5 into Consensys-Incorporated:main Aug 10, 2026
12 of 13 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 10, 2026
@rolfyone

Copy link
Copy Markdown
Contributor

@rolfyone

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.

yes the point was we're hours from finishing the release and this is not in the release.

@lucassaldanha

Copy link
Copy Markdown
Contributor

The Teku docs are versioned, so this change would only apply in the "Development"

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.

@lucassaldanha

Copy link
Copy Markdown
Contributor

Created https://github.com/Consensys/teku-internal/issues/313 to capture this "timing" issue and potentially fix this for future releases.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants