Skip to content

Commit

Permalink
update docs for homebrew
Browse files Browse the repository at this point in the history
  • Loading branch information
synfinatic committed Mar 4, 2023
1 parent 675e168 commit 219f58b
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/md-links-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@ jobs:
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
folder-path: ./docs
file-path: ./README.md ./CHANGELOG.md
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -468,7 +468,8 @@

Initial release

[Unreleased]: https://github.com/synfinatic/aws-sso-cli/compare/v1.9.9...main
[Unreleased]: https://github.com/synfinatic/aws-sso-cli/compare/v1.9.10...main
[v1.9.10]: https://github.com/synfinatic/aws-sso-cli/releases/tag/v1.9.9
[v1.9.9]: https://github.com/synfinatic/aws-sso-cli/releases/tag/v1.9.9
[v1.9.8]: https://github.com/synfinatic/aws-sso-cli/releases/tag/v1.9.8
[v1.9.7]: https://github.com/synfinatic/aws-sso-cli/releases/tag/v1.9.7
Expand Down
21 changes: 21 additions & 0 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
* [Which SecureStore should I use?](#which-securestore-should-i-use)
* [Does aws-sso support using AWS FIPS endpoints?](#does-aws-sso-support-using-aws-fips-endpoints)
* [How can I stop typing my password all the time?](#how-can-i-stop-typing-my-password-all-the-time)
* [I'm now getting a warning in macOS after upgrading aws-sso-cli](#im-now-getting-a-warning-in-macos-after-upgrading-aws-sso-cli)

##### Errors and their meaning

Expand All @@ -34,6 +35,7 @@

* [How good is the Windows support?](#how-good-is-the-windows-support)
* [How can I say thanks?](#how-can-I-say-thanks)
* [What is the story with Homebrew support?](#what-is-the-story-with-homebrew-support)

---

Expand Down Expand Up @@ -366,3 +368,22 @@ every time you use `aws-sso`. For that reason, I recommend using the [pass](
https://www.passwordstore.org) option which uses GPG and optionally the `gpg-agent`
for caching of your GPG passphrase. Please note that configuring pass, GPG
and the gpg-agent are outside of the scope of this documentation.

### What is the story with Homebrew support?

Initially, `aws-sso-cli` was distributed as an [independant tap](
https://github.com/synfinatic/homebrew-aws-sso-cli) but as of
[v1.9.10](../CHANGELOG.md#v1.9.10) it has been added to homebrew-core.

As of v1.9.10, I will no longer be maintaing the above tap, but because
of the way homebrew works, the version in homebrew-core supercedes the
old tap so no user intervention is necessary.

### I'm now getting a warning in macOS after upgrading aws-sso-cli?

As of v1.9.10, `aws-sso-cli` is now distributed as a bottle in homebrew and
these binaries are not signed and will generate a warning that the binary
has changed.

If you prefer the old way of building locally from source to avoid the warning
you should use `brew install -s aws-sso-cli` or `brew upgrade -s aws-sso-cli`.
4 changes: 3 additions & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@
* Option 2: [Download RPM or DEB package](https://github.com/synfinatic/aws-sso-cli/releases)
1. Use your package manager to install (Linux only)
* Option 3: Build & Install via [Homebrew](https://brew.sh)
1. Run `brew tap synfinatic/aws-sso-cli`
1. Run `brew install aws-sso-cli`
Note: You no longer need to install the hombrew tap as `aws-sso-cli` is
now part of [homebrew-core](
https://github.com/Homebrew/homebrew-core/blob/master/Formula/aws-sso-cli.rb).
* Option 4: Build from source:
1. Install [GoLang](https://golang.org) v1.17+ and GNU Make
1. Clone this repo
Expand Down

0 comments on commit 219f58b

Please sign in to comment.