docs: remove deprecated --skip-tls references from local-development guide#2231
Conversation
There was a problem hiding this comment.
Pull request overview
Removes outdated documentation for the deprecated --skip-tls flag in the local development guide so troubleshooting advice matches current CLI behavior.
Changes:
- Replaced
--skip-tlsexample commands with a deprecation note and alternative guidance. - Updated the “Common Issues” table entry for corporate-network TLS errors to remove the deprecated recommendation.
Show a summary per file
| File | Description |
|---|---|
docs/local-development.md |
Removes --skip-tls usage references and updates TLS troubleshooting guidance to reflect deprecation. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 3
| @@ -130,14 +130,10 @@ Or copy only the modified CLI portion if you want a lighter sandbox. | |||
|
|
|||
| ## 9. Debug Network / TLS Skips | |||
There was a problem hiding this comment.
Section title still says "TLS Skips" even though the --skip-tls option is now described as deprecated/ineffective. Consider renaming the heading to avoid implying TLS bypass behavior (e.g., "Debug Network / TLS" or similar).
| ## 9. Debug Network / TLS Skips | |
| ## 9. Debug Network / TLS |
| ``` | ||
|
|
||
| (Use only for local experimentation.) | ||
|
|
There was a problem hiding this comment.
There are two consecutive blank lines before the next section header, which is inconsistent with the surrounding formatting. Remove one of the blank lines to keep spacing consistent.
| > **Note:** The `--skip-tls` flag is deprecated and no longer has any effect. | ||
| > If you encounter TLS errors on a corporate network, configure your | ||
| > environment's certificate store or proxy instead. |
There was a problem hiding this comment.
The guidance "configure your environment's certificate store or proxy" is accurate but a bit non-actionable for a local-dev troubleshooting section. Consider adding 1–2 concrete examples (e.g., typical proxy env vars like HTTP(S)_PROXY and/or CA bundle env vars like SSL_CERT_FILE / REQUESTS_CA_BUNDLE) so readers know what to try next.
mnriem
left a comment
mnriem
left a comment
There was a problem hiding this comment.
Please address Copilot feedback. If not applicable, please explain why
There was a problem hiding this comment.
Pull request overview
Updates the local development guide to remove outdated documentation for the deprecated --skip-tls flag and replace it with guidance that reflects the CLI’s current behavior.
Changes:
- Replaced the “TLS skip” example commands with a deprecation note and recommended troubleshooting direction.
- Updated the Common Issues table entry for corporate-network TLS errors to remove the
--skip-tlssuggestion.
Show a summary per file
| File | Description |
|---|---|
| docs/local-development.md | Removes deprecated --skip-tls usage examples and updates TLS troubleshooting guidance to reflect the flag being a no-op. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (1)
docs/local-development.md:165
- The Common Issues table entry repeats the longer guidance from Section 9, which can drift over time. Consider keeping the table cell short and pointing to Section 9 for the full TLS/corporate network troubleshooting steps (while still noting that
--skip-tlsis deprecated).
| TLS errors on corporate network | Configure your environment's certificate store or proxy. The `--skip-tls` flag is deprecated and has no effect. |
- Files reviewed: 1/1 changed files
- Comments generated: 0 new
|
Thanks for the review! I've addressed the feedback:
Please let me know if anything else should be adjusted. |
There was a problem hiding this comment.
Pull request overview
Removes outdated documentation for the deprecated --skip-tls CLI flag in the local development guide, replacing it with guidance that reflects the current behavior (flag is a no-op) and points developers toward proper TLS/proxy configuration.
Changes:
- Renamed Section 9 to focus on TLS issues (instead of “TLS skips”) and replaced the old
--skip-tlsexamples with deprecation + environment configuration guidance. - Updated the “Common Issues” table to stop recommending
--skip-tlsfor corporate-network TLS failures.
Show a summary per file
| File | Description |
|---|---|
| docs/local-development.md | Removes deprecated --skip-tls references and replaces them with current TLS troubleshooting guidance. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0 new
|
Thank you! |
Summary
The
--skip-tlsflag is deprecated and no longer has any effect onspecify initorspecify check. However,docs/local-development.mdstill documents it as a working option in two places:
--skip-tls--skip-tlsfor TLS errorsThis PR removes the outdated references and replaces them with accurate guidance.
Changes
docs/local-development.md: Updated Section 9 and Section 12 tableVerification
Running
specify init --helpconfirms--skip-tlsis not listed as an option.AI Disclosure
I used Claude Code to help identify this issue by analyzing the repository files.
The fix was manually verified and applied by me.