Skip to content

Commit 9c01abe

Browse files
authored
[main] Update documentation to reflect v6 and v7 branches are no longer maintained (#3676)
* Update documentation to reflect v6 and v7 branches are no longer maintained - Remove v7 from PR template branch requirements - Update CONTRIBUTING.md to mark v6 and v7 as no longer maintained - Add deprecation notices to v6 and v7 installation docs - Update GitHub issue templates to reflect current support status - Update README.md to focus on v8 as the current supported version - Mark ADR 0010 as superseded since v7 branch workflow is obsolete * Fix wording: use 'no longer maintained' instead of 'no longer maintained or released'
1 parent 627d81a commit 9c01abe

File tree

7 files changed

+19
-15
lines changed

7 files changed

+19
-15
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ mailing list.
1010
The cf CLI follows a branching model:
1111
- V9 (Next major release) of the cf CLI is built from the [main branch](https://github.com/cloudfoundry/cli/tree/main). **This branch is under active development**.
1212
- V8 of the cf CLI is built from the [v8 branch](https://github.com/cloudfoundry/cli/tree/v8). **This branch is under active development**.
13-
- V7 of the cf CLI is built from the [v7 branch](https://github.com/cloudfoundry/cli/tree/v7). **This branch is maintenance only** and will only be updated to patch CVEs and very severe blocking defects.
14-
- V6 of the cf CLI is built from the [v6 branch](https://github.com/cloudfoundry/cli/tree/v6). **This branch is maintenance only** and will only be updated to patch CVEs and very severe blocking defects.
13+
- V7 of the cf CLI is built from the [v7 branch](https://github.com/cloudfoundry/cli/tree/v7). **This branch is no longer maintained**.
14+
- V6 of the cf CLI is built from the [v6 branch](https://github.com/cloudfoundry/cli/tree/v6). **This branch is no longer maintained**.
1515

1616
## Prerequisites
1717
Before working on a PR to the CLI code base, please:
@@ -33,11 +33,11 @@ After reaching out to the CLI team and the conclusion is to make a PR, please fo
3333
[Product Style Guide](https://github.com/cloudfoundry/cli/wiki/CLI-Product-Specific-Style-Guide),
3434
and [Internationalization Guide](https://github.com/cloudfoundry/cli/wiki/Internationalization-Guide).
3535
1. Fork the project repository.
36-
1. Create a feature branch from the earliest branch that's [appropriate for your change](#cli-versions) (e.g. `git checkout v7 && git checkout -b better_cli`) and make changes on this branch
36+
1. Create a feature branch from the earliest branch that's [appropriate for your change](#cli-versions) (e.g. `git checkout v8 && git checkout -b better_cli`) and make changes on this branch
3737
* Follow the other sections on this page to [set up your development environment](#development-environment-setup), [build `cf`](#building-the-cf-binary) and [run the tests](#testing).
3838
* Tests are required for any changes.
3939
1. Push to your fork (e.g. `git push origin better_cli`) and [submit a pull request](https://help.github.com/articles/creating-a-pull-request)
40-
1. The cf CLI team will merge your changes from the versioned branch (e.g. v7) to main for you after the PR is merged.
40+
1. The cf CLI team will merge your changes from the versioned branch (e.g. v8) to main for you after the PR is merged.
4141

4242
Note: All contributions must be sent using GitHub Pull Requests.
4343
We prefer a small, focused pull request with a clear message

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ Steps to reproduce the behavior; include the exact CLI commands and verbose outp
3232
- version of the CC API Release you are on
3333

3434
**Notes regarding V6 and V7 CLI support:**
35-
- V6:
36-
- Minimum supported version of CF Deployment: v7.0.0 (CAPI Release: 1.74.0 (APIs 2.128.0 and 3.63.0))
37-
- Maximum supported version of CF Deployment: v13.4.0 (CAPI Release: 1.94.0 (APIs 2.149.0 and 3.84.0))
38-
- V7:
39-
- Minimum supported version of CF Deployment: v13.5.0 (CAPI Release: 1.95.0 (APIs 2.150.0 and 3.85.0))
35+
- V6: **No longer maintained or released**
36+
- Last supported version of CF Deployment: v13.4.0 (CAPI Release: 1.94.0 (APIs 2.149.0 and 3.84.0))
37+
- V7: **No longer maintained or released**
38+
- Last supported version of CF Deployment: v13.5.0 (CAPI Release: 1.95.0 (APIs 2.150.0 and 3.85.0))
4039

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ A clear and concise description of any alternative solutions or features you've
3131
Add any other context or screenshots about the feature request here.
3232

3333
**Note:**
34-
As of the GA of the v7 CLI, the v6 line is no longer under active development and will be updated only to patch CVEs or fix severe blocking defects with no workarounds.
34+
The v7 and v6 CLI versions are no longer maintained.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ If your contribution falls under a company CLA but your membership is not public
99
* Contributions must conform to our [style guide](https://github.com/cloudfoundry/cli/wiki/CLI-Product-Specific-Style-Guide). Please reach out to us if you have questions.
1010

1111

12-
#### Note: Please create separate PR for every branch (main, v8 and v7) as needed.
12+
#### Note: Please create separate PR for every branch (main and v8) as needed.
1313

1414
## Description of the Change
1515

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,13 @@ CF CLI Binary Download Server's uptime:
3535

3636
***
3737
## Getting Started
38-
Download and install the cf CLI from the [Downloads Section](#downloads) for either the [v8 cf CLI](https://github.com/cloudfoundry/cli/wiki/V8-CLI-Installation-Guide) or the [v7 cf CLI](https://github.com/cloudfoundry/cli/wiki/V7-CLI-Installation-Guide).
38+
Download and install the cf CLI from the [Downloads Section](#downloads) for the [v8 cf CLI](https://github.com/cloudfoundry/cli/wiki/V8-CLI-Installation-Guide).
3939

4040
Once installed, you can log in and push an app.
41-
There are now three supported versions of the cf CLI:
41+
The currently supported version of the cf CLI:
4242
1. The v8 cf CLI is backed by the [v3 CC API](http://v3-apidocs.cloudfoundry.org/version/3.85.0/) (with the exception of plugins). See [our v8 documentation](https://docs.cloudfoundry.org/cf-cli/v8.html) for more information.
43-
1. The v7 cf CLI is backed by the [v3 CC API](http://v3-apidocs.cloudfoundry.org/version/3.85.0/) (with the exception of plugins). See [our v7 documentation](https://docs.cloudfoundry.org/cf-cli/v7.html) for more information.
43+
44+
**Note**: v7 and v6 CLI versions are no longer maintained or released.
4445

4546
View our [CLI v7 & v8 Versioning and Support Policy](https://github.com/cloudfoundry/cli/wiki/Versioning-and-Support-Policy) documentation.
4647

@@ -61,8 +62,8 @@ Check out our [community contributed CLI plugins](https://plugins.cloudfoundry.o
6162
## Downloads
6263

6364
### Installation instructions
64-
- [Install V7](https://github.com/cloudfoundry/cli/wiki/V7-CLI-Installation-Guide)
6565
- [Install V8](https://github.com/cloudfoundry/cli/wiki/V8-CLI-Installation-Guide)
66+
- [Install V7](https://github.com/cloudfoundry/cli/wiki/V7-CLI-Installation-Guide) (**DEPRECATED** - no longer maintained)
6667
- [Switching Between Multiple Versions](https://github.com/cloudfoundry/cli/wiki/Version-Switching-Guide)
6768

6869
## Known Issues

doc/installation-instructions/installation-instructions-v6.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
### Downloading the latest V6 CF CLI
22

3+
**DEPRECATED**: The v6 CF CLI is no longer maintained or released. Please consider upgrading to v8 or later versions. This documentation is kept for historical reference only.
4+
35
#### Installing using a package manager
46

57
**Mac OS X** and **Linux** using [Homebrew](https://brew.sh/) via the [cloudfoundry tap](https://github.com/cloudfoundry/homebrew-tap):

doc/installation-instructions/installation-instructions-v7.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
### Downloading the latest V7 CF CLI
22

3+
**DEPRECATED**: The v7 CF CLI is no longer maintained or released. Please consider upgrading to v8 or later versions. This documentation is kept for historical reference only.
4+
35
**Important Note**: The v7 CF CLI is now GA and the binary has been renamed from `cf7` to `cf`. If you're already using the v7 CLI in parallel to the v6 CLI, you may need to change your workflow to accomodate the binary name change. See the [Version Switching](#version-switching) section for instructions. For more information and general status on the v7 CLI, please check [releases](https://github.com/cloudfoundry/cli/releases).
46

57
#### Compatibility

0 commit comments

Comments
 (0)