Skip to content

Commit

Permalink
Merge pull request #251 from OctopusDeploy/sunset-notice
Browse files Browse the repository at this point in the history
added sunset notice to readme
  • Loading branch information
benPearce1 authored Jan 30, 2023
2 parents c5352d5 + b9d396a commit 1f580de
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,46 @@
## Notice

Octopus CLI is no longer under feature development. All feature development of the Octopus CLI is being done in the updated [cli](https://github.com/OctopusDeploy/cli).
This tool will continue to be supported for security patches until July 2023.

---

This repository contains the Octopus CLI (`octo`) for [Octopus][1], a user-friendly DevOps tool for developers that supports release management, deployment automation, and operations runbooks. You can use it to create and deploy releases, create and push packages, and manage environments.

`octo` can be [downloaded from the Octopus downloads page][2].

## Documentation

- [octo][3]

## Issues

Please see [Contributing](CONTRIBUTING.md)

## Development

### Pre-requisites

You need the following items installed on your system:

- Rider, VSCode or Visual Studio 15.3
- .NET Core SDK 6.x

### Build and Test

Run the build script to build, test and package the project.
Run the build script to build, test and package the project.

**Do this before pushing as it will run the surface area tests as well, which require approval on almost every change.**

#### Unix-like systems

```
# on Unix-like systems we don't generate the OctopusTools NuGet package as it calls `nuget.exe` to create the package.
$ ./build.sh
```

#### Windows

```
> build.cmd
```
Expand All @@ -40,11 +52,12 @@ To release a new version, tag `main` with the next `<major>.<minor>.<patch>` ver
Every successful GitHub Actions build for all branches will be pushed to Feedz.io.

## Compatibility

See the [Compatibility][4] page in our docs

[1]: https://octopus.com
[2]: https://octopus.com/downloads
[3]: https://octopus.com/docs/api-and-integration/octo.exe-command-line
[4]: https://octopus.com/docs/api-and-integration/compatibility
[5]: https://github.com/OctopusDeploy/OctopusCLI/actions/workflows/build.yml
[6]: https://deploy.octopus.app/app#/Spaces-62/projects/octopus-cli/deployments
[6]: https://deploy.octopus.app/app#/Spaces-62/projects/octopus-cli/deployments

0 comments on commit 1f580de

Please sign in to comment.