Skip to content

docs: document difyctl version-compatibility gate for Dify 1.16.0#845

Merged
RiskeyL merged 9 commits into
release/1.16.0from
docs/cli-1.16.0-compat
Jul 9, 2026
Merged

docs: document difyctl version-compatibility gate for Dify 1.16.0#845
RiskeyL merged 9 commits into
release/1.16.0from
docs/cli-1.16.0-compat

Conversation

@RiskeyL

@RiskeyL RiskeyL commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates the CLI reference for difyctl 0.2.0-alpha and Dify 1.16.0, and documents the version-compatibility gate introduced upstream in langgenius/dify#38367. It targets release/1.16.0 because it describes behavior that ships with the 1.16.0 release — the version samples show the server at 1.16.0, which holds once Cloud is on 1.16.0. All changes cover en, zh, and ja.

The /openapi/v1 path refactor from that PR is internal to how difyctl calls the server, so it stays out of the docs, which describe commands rather than raw endpoints.

Changes

Version and compatibility model (version.mdx)

  • Bumps the samples to difyctl 0.2.0-alpha, server 1.16.0, compat range [1.16.0, 1.16.0].
  • Reworks the verdict model from three to four verdicts (compatible / too_old / too_new / unknown), with a Shown as column carrying the exact labels difyctl prints (ok, incompatible (server too old), and so on).

The version-compatibility gate (version.mdx)

Adds a "How Commands React to an Incompatible Server" section: too_old hard-fails with exit 6 before the request, too_new runs with a stderr warning, a passing check is cached about an hour per host, auth login runs the same check, and the symmetric server-side 426 path is explained. --check-compat (exit 64) is documented as a live, uncached probe, suitable for CI gating.

Troubleshooting and exit codes

  • New Version Compatibility entry in troubleshooting.mdx (version_skew): both failure directions, how to confirm with difyctl version, and the fix (reinstall / pin DIFY_VERSION).
  • Exit-6 rows updated in output-formats-and-exit-codes.mdx and auth-and-contexts.mdx.

Install (install.mdx)

Clarifies that difyctl works with Dify 1.15.0 and later and that each build matches a Dify version. The supported floor stays 1.15.0 (older servers pin DIFY_VERSION); only the latest build requires 1.16.0. The 1.15.0 in the examples is intentional, not a stale value.

Fix

Translates the version page title in zh/ja (版本 / バージョン) — it was the only CLI reference page with an untranslated title.

Copilot AI review requested due to automatic review settings July 8, 2026 10:19
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 8, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Dify CLI docs to reflect the difyctl 0.2.0-alpha / Dify 1.16.0 compatibility model, including the new compatibility verdicts and the version-compatibility gate behavior, and adds documentation for the NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW env var (now defaulting to true in 1.16.0).

Changes:

  • Refreshes difyctl version samples to difyctl 0.2.0-alpha / server 1.16.0, and expands compatibility verdicts to compatible / too_old / too_new / unknown.
  • Adds troubleshooting guidance for version_skew and updates exit-code 6 references across CLI docs.
  • Documents NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW in environment variable tables and updates internal env-var audit notes.

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
en/cli/reference/version.mdx Updates version output samples and documents compatibility verdicts + gating behavior.
en/cli/troubleshooting.mdx Adds version_skew troubleshooting entry (exit 6).
en/cli/reference/output-formats-and-exit-codes.mdx Expands exit code 6 examples to include version_skew/HTTP 426 direction.
en/cli/reference/auth-and-contexts.mdx Updates auth login exit code 6 description to mention version gate.
en/cli/install.mdx Clarifies supported server floor (1.15.0+) and “builds match server versions”.
en/self-host/deploy/configuration/environments.mdx Documents NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW (default true).
zh/cli/reference/version.mdx Chinese translation of updated version/compatibility docs (incl. new sections).
zh/cli/troubleshooting.mdx Adds Chinese version_skew troubleshooting entry.
zh/cli/reference/output-formats-and-exit-codes.mdx Updates Chinese exit code 6 row with version_skew details.
zh/cli/reference/auth-and-contexts.mdx Updates Chinese auth login exit code 6 description.
zh/cli/install.mdx Updates Chinese install note about version targeting.
zh/self-host/deploy/configuration/environments.mdx Adds Chinese row for NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW.
ja/cli/reference/version.mdx Japanese translation of updated version/compatibility docs (incl. new sections).
ja/cli/troubleshooting.mdx Adds Japanese version_skew troubleshooting entry.
ja/cli/reference/output-formats-and-exit-codes.mdx Updates Japanese exit code 6 row with version_skew details.
ja/cli/reference/auth-and-contexts.mdx Updates Japanese auth login exit code 6 description.
ja/cli/install.mdx Updates Japanese install note about version targeting.
ja/self-host/deploy/configuration/environments.mdx Adds Japanese row for NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW.
.claude/skills/dify-docs-env-vars/ignored-vars.md Removes NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW from “ignored vars” list now that it’s documented.
.claude/skills/dify-docs-env-vars/deep-dive.md Adds internal deep-dive notes for NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW default flip in 1.16.0.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread en/cli/reference/version.mdx Outdated
Comment thread en/cli/reference/version.mdx Outdated
Comment thread en/cli/reference/version.mdx Outdated
Comment thread zh/cli/reference/version.mdx Outdated
Comment thread zh/cli/reference/version.mdx Outdated
Comment thread zh/cli/reference/version.mdx Outdated
Comment thread ja/cli/reference/version.mdx Outdated
Comment thread ja/cli/reference/version.mdx Outdated
Comment thread ja/cli/reference/version.mdx Outdated
Copilot AI review requested due to automatic review settings July 8, 2026 10:42

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 23 out of 23 changed files in this pull request and generated 7 comments.

Comment thread en/cli/troubleshooting.mdx Outdated
Comment thread en/cli/reference/auth-and-contexts.mdx Outdated
Comment thread zh/cli/reference/auth-and-contexts.mdx Outdated
Comment thread ja/cli/reference/auth-and-contexts.mdx Outdated
Comment thread en/cli/reference/version.mdx Outdated
Comment thread en/cli/reference/version.mdx Outdated
Comment thread .claude/skills/dify-docs-env-vars/deep-dive.md
Copilot AI review requested due to automatic review settings July 8, 2026 10:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 23 out of 23 changed files in this pull request and generated 3 comments.

Comment thread en/cli/install.mdx
Comment thread en/cli/reference/version.mdx Outdated
Comment thread en/cli/reference/version.mdx Outdated
Copilot AI review requested due to automatic review settings July 8, 2026 10:57

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 26 out of 26 changed files in this pull request and generated 6 comments.

Comment thread en/cli/reference/version.mdx Outdated
Comment thread zh/cli/reference/version.mdx Outdated
Comment thread ja/cli/reference/version.mdx Outdated
Comment thread en/cli/install.mdx Outdated
Comment thread zh/cli/install.mdx Outdated
Comment thread ja/cli/install.mdx Outdated
Copilot AI review requested due to automatic review settings July 8, 2026 11:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 26 out of 26 changed files in this pull request and generated 6 comments.

Comment thread en/cli/reference/auth-and-contexts.mdx Outdated
Comment thread en/cli/reference/auth-and-contexts.mdx Outdated
Comment thread zh/cli/reference/auth-and-contexts.mdx Outdated
Comment thread zh/cli/reference/auth-and-contexts.mdx Outdated
Comment thread ja/cli/reference/auth-and-contexts.mdx Outdated
Comment thread ja/cli/reference/auth-and-contexts.mdx Outdated
Copilot AI review requested due to automatic review settings July 8, 2026 11:19

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 26 out of 26 changed files in this pull request and generated 4 comments.

Comment thread en/cli/authenticate.mdx Outdated
Comment thread zh/cli/authenticate.mdx Outdated
Comment thread ja/cli/authenticate.mdx Outdated
Comment thread .claude/skills/dify-docs-env-vars/deep-dive.md
Copilot AI review requested due to automatic review settings July 8, 2026 11:33

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 26 out of 26 changed files in this pull request and generated 2 comments.

Comment thread en/cli/install.mdx Outdated
Comment thread ja/cli/install.mdx Outdated
Copilot AI review requested due to automatic review settings July 8, 2026 11:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 26 out of 26 changed files in this pull request and generated 4 comments.

Comment thread en/cli/install.mdx
Comment thread zh/cli/install.mdx
Comment thread ja/cli/install.mdx
Comment thread en/self-host/deploy/configuration/environments.mdx

@lin-snow lin-snow left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Jul 8, 2026
@RiskeyL RiskeyL merged commit 6151419 into release/1.16.0 Jul 9, 2026
6 checks passed
@RiskeyL RiskeyL deleted the docs/cli-1.16.0-compat branch July 9, 2026 02:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants