Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cleanup docs and remove completions pre-1.9 #1032

Merged
merged 1 commit into from
Aug 20, 2024
Merged

cleanup docs and remove completions pre-1.9 #1032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .codecov.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ coverage:
status:
project:
target: auto
threshold: 0%
paths:
- internal/*
- sso/*
threshold: 0.25%

ignore:
- cmd/**

4 changes: 1 addition & 3 deletions LICENSE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
GNU General Public License
==========================
# GNU General Public License

_Version 3, 29 June 2007_
_Copyright © 2007 Free Software Foundation, Inc. &lt;<http://fsf.org/>&gt;_
Expand Down Expand Up @@ -593,4 +592,3 @@ more useful to permit linking proprietary applications with the library. If this
what you want to do, use the GNU Lesser General Public License instead of this
License. But first, please read
&lt;<http://www.gnu.org/philosophy/why-not-lgpl.html>&gt;.

48 changes: 6 additions & 42 deletions cmd/aws-sso/completions_cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,18 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import (
"bytes"
"fmt"
"os"

"github.com/synfinatic/aws-sso-cli/internal/helper"
"github.com/willabides/kongplete"
)

type CompleteCmd struct {
Source bool `kong:"help='Print out completions for sourcing in the active shell',xor='action'"`
Install bool `kong:"short='I',help='Install shell completions',xor='action'"`
Uninstall bool `kong:"short='U',help='Uninstall shell completions',xor='action'"`
UninstallPre19 bool `kong:"help='Uninstall pre-v1.9 shell completion integration',xor='action',xor='shell,script'"`
Shell string `kong:"help='Override detected shell',xor='shell'"`
ShellScript string `kong:"help='Override file to (un)install shell completions',xor='script'"`
Source bool `kong:"help='Print out completions for sourcing in the active shell',xor='action'"`
Install bool `kong:"short='I',help='Install shell completions',xor='action'"`
Uninstall bool `kong:"short='U',help='Uninstall shell completions',xor='action'"`
Shell string `kong:"help='Override detected shell'"`
ShellScript string `kong:"help='Override file to (un)install shell completions'"`
}

// AfterApply determines if SSO auth token is required
Expand All @@ -45,28 +42,13 @@
var err error

if ctx.Cli.Setup.Completions.Source {
err = helper.NewSourceHelper(os.Executable, os.Stdout).
Generate(ctx.Cli.Setup.Completions.Shell)
return helper.NewSourceHelper(os.Executable, os.Stdout).Generate(ctx.Cli.Setup.Completions.Shell)

Check warning on line 45 in cmd/aws-sso/completions_cmd.go

View check run for this annotation

Codecov / codecov/patch

cmd/aws-sso/completions_cmd.go#L45 

Added line #L45 was not covered by tests
} else if ctx.Cli.Setup.Completions.Install {
// install the current auto-complete helper
err = helper.InstallHelper(ctx.Cli.Setup.Completions.Shell, ctx.Cli.Setup.Completions.ShellScript)
} else if ctx.Cli.Setup.Completions.Uninstall {
// uninstall the current auto-complete helper
err = helper.UninstallHelper(ctx.Cli.Setup.Completions.Shell, ctx.Cli.Setup.Completions.ShellScript)
} else if ctx.Cli.Setup.Completions.UninstallPre19 {
// make sure we haven't installed our new completions first...
if files := hasV19Installed(); len(files) == 0 {
for _, f := range files {
fmt.Printf("%s has the newer shell completions\n", f)
}
return fmt.Errorf("unable to automatically uninstall pre-1.9 shell completions")
}

// Uninstall the old kongplete auto-complete helper
kp := &kongplete.InstallCompletions{
Uninstall: true,
}
err = kp.Run(ctx.Kctx)
} else {
err = fmt.Errorf("please specify a valid flag")
}
Expand All @@ -76,21 +58,3 @@
}
return err
}

// hasV19Installed returns the paths to any shell script we manage
// that has the old < v1.9 completions installed or an empty list
// if none exist.
func hasV19Installed() []string {
ret := []string{}
for _, f := range helper.ConfigFiles() {
b, err := os.ReadFile(f)
if err != nil {
continue
}
if bytes.Contains(b, []byte("# BEGIN_AWS_SSO_CLI\n")) {
ret = append(ret, f)
}
}

return ret
}
11 changes: 6 additions & 5 deletions docs/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,16 +278,17 @@ quickstart.md#enabling-auto-completion-in-your-shell).

Flags:

* `--source` -- Print out the completions for sourcing into the current shell
* `--install` -- Install the new v1.9+ shell completions scripts
* `--uninstall` -- Uninstall the new v1.9+ shell completions scripts
* `--uninstall-pre-19` -- Uninstall the legacy pre-v1.9 scripts
* `--shell <shell>` -- Override the detected shell
* `--shell-script <file>` -- Override the default shell script file to modify

**Note:** You should uninstall the older pre-v1.9 completions before installing
the new version. Once the new version is installed, `--uninstall-pre-19` will
refuse to run so you will have to either manually edit the file or run
`--uninstall`, then `--uninstall-pre-19` and finally `--install` again.
---

### setup ecs

See the [setup ecs](ecs-commands.md#setup-ecs) commands in the ECS Server command documentation.

---

Expand Down
6 changes: 4 additions & 2 deletions docs/ecs-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ For information about the ECS Server functionality, see the [ecs-server](ecs-ser

## Commands

### setup ecs auth
### setup ecs

#### setup ecs auth

Configures the HTTP Authentication BearerToken. Once set, all future client
requests to the ECS Server will need to provide the correct credentials.
Expand All @@ -20,7 +22,7 @@ Flags:

---

### setup ecs ssl
#### setup ecs ssl

Configures the SSL Certificate and Private Key to enable SSL/TLS. Saves the
SSL certificate and private key to the SecureStore.
Expand Down
41 changes: 9 additions & 32 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
now part of [homebrew-core](
https://github.com/Homebrew/homebrew-core/blob/master/Formula/a/aws-sso-cli.rb).
* Option 4: Build from source:
1. Install [GoLang](https://golang.org) v1.17+ and GNU Make
1. Install [GoLang](https://golang.org) v1.22+ and GNU Make
1. Clone this repo
1. Run `make` (or `gmake` for GNU Make)
1. Your binary will be created in the `dist` directory
1. Run `make install` to install in /usr/local/bin
* Option 5: `go install`:
1. Install [GoLang](https://golang.org) v1.19+ and GNU Make
1. Install [GoLang](https://golang.org) v1.22+ and GNU Make
1. `go install github.com/synfinatic/aws-sso-cli/cmd/aws-sso@latest`

Note: macOS binaries must be build on macOS to enable Keychain support.
Expand Down Expand Up @@ -47,8 +47,8 @@ For more information about configuring `aws-sso` read the
[configuration guide](config.md).

You can re-run through the configuration wizard at any time by running
`aws-sso config`. By default, this only does a very basic setup; for a more
advanced setup, use `aws-sso config --advanced`.
`aws-sso setup wizard`. By default, this only does a very basic setup; for a more
advanced setup, use `aws-sso setup wizard --advanced`.

## Enabling auto-completion in your shell

Expand All @@ -65,34 +65,11 @@ shell for those changes to take effect.
Guided setup should of prompted you to install auto-completions, but
you can always re-run it for a different shell:

`aws-sso completions -I`
`aws-sso setup completions -I`

or if you wish to uninstall them:

`aws-sso completions -U`

---

### Upgrading from before v1.9.0

First, there is no longer an `install-completions` command as of v1.9.0,
that functionality (and more) has been moved to `completions`.

You should _first_ uninstall the old completions (sorry) and then install
the new versions. This manual uninstall/re-install is a one time thing,
but necessary.

1. `aws-sso completions --uninstall-pre-19`
2. `aws-sso completions -I`

Users of older versions will note that starting in v1.9.0, running
`completions -I` or `completions -U` will present you a diff of file changes
for you to accept.

Also, unlike with older versions, only your current shell is modified when
you run `completions -I` or `completions -U`, but
`completions --uninstall-pre-19` uses the original code/library and will
modify your `bash`, `zsh` and `fish` init scripts.
`aws-sso setup completions -U`

---

Expand All @@ -101,7 +78,7 @@ modify your `bash`, `zsh` and `fish` init scripts.
Upgrading from versions 1.9.0 or better is just like installing for
first time users:

`aws-sso completions -I`
`aws-sso setup completions -I`

Any changes will be presented to you in diff format and you will be given
the option to accept or reject the changes.
Expand All @@ -111,7 +88,7 @@ the option to accept or reject the changes.
### More information

More information on auto-completion can be found in the documentation
for the [completions command](commands.md#completions).
for the [setup completions](commands.md#setup-completions) command.

## Use `aws-sso` on the CLI for AWS API calls

Expand Down Expand Up @@ -191,7 +168,7 @@ and the `$AWS_PROFILE` environment variable, AWS SSO CLI can support that as wel

#### Configuration

Run: `aws-sso config-profiles`
Run: `aws-sso setup profiles`

This will add the following lines (example) to your `~/.aws/config` file:

Expand Down
Loading