From 203c75253cdc0e9b1a2de6e1e53f18edfbf37ca5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Engin=20A=C3=A7=C4=B1kg=C3=B6z?= Date: Sun, 25 Aug 2024 18:31:11 +0300 Subject: [PATCH 1/5] Add badges --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 0803ae0..e508bb0 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ GAMA is a powerful terminal-based user interface tool designed to streamline the management of GitHub Actions workflows. It allows developers to list, trigger, and manage workflows with ease directly from the terminal. +GAMA Go Version +GAMA Go Report Card +GAMA Licence + ![gama demo](docs/gama.gif) ## Key Features From 7c28d0c150734e7f65610e0b10319c8d7824209e Mon Sep 17 00:00:00 2001 From: Jelloeater Date: Tue, 3 Sep 2024 15:15:42 -0400 Subject: [PATCH 2/5] Added GH Token Auth --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index e508bb0..152f564 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,12 @@ Alternatively, you can use an environment variable: GITHUB_TOKEN="" gama ``` +If you have the [GitHub CLI](https://cli.github.com/) installed, you can use + +```bash +export GITHUB_TOKEN="$(gh auth token)" gama +``` + ## Build & Installation ### Using Docker From f5e2cd3af96dedfd3aef2872fa7e28d33ff0bac7 Mon Sep 17 00:00:00 2001 From: Jelloeater Date: Wed, 4 Sep 2024 00:56:22 -0400 Subject: [PATCH 3/5] Update README.md --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 152f564..2e2f205 100644 --- a/README.md +++ b/README.md @@ -48,12 +48,16 @@ Alternatively, you can use an environment variable: GITHUB_TOKEN="" gama ``` -If you have the [GitHub CLI](https://cli.github.com/) installed, you can use +If you have the [GitHub CLI](https://cli.github.com/) installed, you automatically insert the var via: ```bash -export GITHUB_TOKEN="$(gh auth token)" gama +GITHUB_TOKEN="$(gh auth token)" gama ``` +This will skip needing to generate a token via the GitHub website. + +**NOTE: You may still need to generate a token via the GUI if you run into errors** + ## Build & Installation ### Using Docker From b5799d668026c155e8ce814914a78fcd57b29fcb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Engin=20A=C3=A7=C4=B1kg=C3=B6z?= Date: Wed, 4 Sep 2024 14:56:22 +0300 Subject: [PATCH 4/5] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 2e2f205..d5bafcc 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,6 @@ GITHUB_TOKEN="$(gh auth token)" gama This will skip needing to generate a token via the GitHub website. -**NOTE: You may still need to generate a token via the GUI if you run into errors** - ## Build & Installation ### Using Docker From 63083034baffccc9bd39ea232192c40d9396cbf1 Mon Sep 17 00:00:00 2001 From: Francesco Pira Date: Thu, 5 Sep 2024 17:22:54 +0200 Subject: [PATCH 5/5] Update README.md with notes for better GITHUB_TOKEN handling --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index d5bafcc..8a5feb6 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,12 @@ Alternatively, you can use an environment variable: GITHUB_TOKEN="" gama ``` +You can also make it an alias for a better experience: + +```bash +alias gama='GITHUB_TOKEN="" command gama' +``` + If you have the [GitHub CLI](https://cli.github.com/) installed, you automatically insert the var via: ```bash @@ -56,6 +62,11 @@ GITHUB_TOKEN="$(gh auth token)" gama This will skip needing to generate a token via the GitHub website. +> [!WARNING] +> For security reasons, you should not `export` your token globally in your shell. +> That would make it available to any app that can read environment variables. +> You should avoid committing it to your dotfiles repository, too. + ## Build & Installation ### Using Docker