bcgov · rustyjux · Nov 22, 2024 · Jun 6, 2024 · Jun 6, 2024 · Jun 6, 2024
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -8,7 +8,7 @@ on:
 env:
   GWA_API_HOST: api.gov.bc.ca
   GWA_CLIENT_ID: gwa-cli
-  GWA_VERSION: v2
+  GWA_VERSION: v3
 
 jobs:
   release-tag:

diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml
@@ -0,0 +1,49 @@
+name: Pre-release
+
+on:
+  push:
+    branches:
+      - pre-release
+
+env:
+  GWA_API_HOST: api.gov.bc.ca
+  GWA_CLIENT_ID: gwa-cli
+  GWA_VERSION: v3
+
+jobs:
+  release-tag:
+    name: create release tag
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - id: release
+        uses: rymndhng/release-on-push-action@v0.28.0
+        with:
+          bump_version_scheme: patch
+          release_body: "This is a prerelease version intended for testing purposes. It may contain new features, improvements, and bug fixes that are not yet fully stable. We encourage you to try it out and provide feedback. If you encounter any issues, please report them on our issue tracker. Thank you for helping us improve!"
+    outputs:
+      version_number: ${{ steps.release.outputs.tag_name }}
+
+  goreleaser:
+    runs-on: ubuntu-latest
+    needs: release-tag
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - run: git fetch --force --tags
+      - uses: extractions/setup-just@v1
+      - uses: actions/setup-go@v4
+        with:
+          go-version: stable
+      - name: Run Unit Tests
+        run: just test
+      - uses: goreleaser/goreleaser-action@v5
+        with:
+          distribution: goreleaser
+          version: v1.20.0
+          args: release --verbose --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CLI_VERSION: ${{ needs.release-tag.outputs.version_number }}
diff --git a/README.md b/README.md
@@ -1,124 +1,65 @@
 # GWA CLI
 
-<img src="https://github.com/bcgov/gwa-cli/workflows/Build/badge.svg"></img>
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gwa-cli&metric=alert_status)](https://sonarcloud.io/dashboard?id=gwa-cli)
 [![img](https://img.shields.io/badge/Lifecycle-Stable-97ca00)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
 
-> **NOTE:** This tool is going through rapid development and could change often. Check back for updates.
 
-`gwa` is a tool for composing, validating and generating Kong Gateway configuration files from OpenAPI (aka Swagger) specs and managing Kong Plugins.
+`gwa` is a tool for composing, validating and publishing Gateway configuration files to the BC Government's [API Services Portal](https://api.gov.bc.ca).
 
-## Documentation
-
-Currently documentation is limited to the APS [USER-JOURNEY.md](https://github.com/bcgov/gwa-api/blob/dev/USER-JOURNEY.md) and via the installed executable's help commands. A hosted website option is in the works and will be available soon.
-
-To run help on any command while using the CLI:
-
-```sh
-$ gwa-cli login --help
-You can login via device login or by using client credentials
-
-To use device login, simply run the command like so:
-    $ gwa login
-
-To use your credentials you must supply both a client-id and client-secret:
-    $ gwa login --client-id <YOUR_CLIENT_ID> --client-secret <YOUR_CLIENT_SECRET>
-...
-
-```
-
-To generate a Markdown-formatted string of every command's documentation to `stdout`, run `$ just docs`. You could then pipe it to a file like so `$ just docs > gwa-commands.md`, though this will be just a temporary solution.
-
-## Development
-
-Prerequisites:
-- [Go](https://go.dev) 1.20 or higher
-- [Just](https://github.com/casey/just) (alternative to `make`)
-- [GoReleaser](https://gore
3419
leaser.com)
-
-Tools:
-- [Cobra] Command line argument parser
-- [Viper](https://github.com/spf13/viper) Configuration file manager, integrates tightly with Cobra
-- [Lipgloss](https://github.com/charmbracelet/lipgloss) Styles and colours
-
-#### Steps to set up dev environment
-
-1. Verify you have Go 1.20+ installed
-
-   ```sh
-   $ go version
-   ```
-   If you don't have `go` installed on your machine, follow instructions on [the Go website](https://golang.org/doc/install).
-
-2. Clone this repository
-
-   ```sh
-   $ git clone git@github.com:bcgov/gwa-cli.git
-   $ cd gwa-cli
-   $ mv env.example .env
-   ```
-   **Note** Some local environments require Go projects are run from the `$HOME/go/src` directory. If any `module not found` errors are reported, try moving it.
-
-   Also be sure to fill in the environment variables before running a command.
-
-3. Run commands
-
-   Test any commmands by running `just run` in the `cwd`. You can also use `$ just test` to run all tests.
-
-   ```sh
-   $ just run namespace current
-   your-namespace
-   $ just test
-   ?   	github.com/bcgov/gwa-cli	[no test files]
-   ok  	github.com/bcgov/gwa-cli/cmd
-   ok  	github.com/bcgov/gwa-cli/pkg
-   ```
+## Installation
 
-4. Set up your IDE
+To get started with `gwa`, follow the detailed instructions provided in the DevHub [installation](https://developer.gov.bc.ca/docs/default/component/aps-infra-platform-docs/how-to/gwa-install/) guide.
 
-   Go has great tooling which is required to ensure code contributed is formatted consitently and is type-safe.
+## Usage
 
-   - **VSCode:** Install the [official Go extension](https://marketplace.visualstudio.com/items?itemName=golang.Go)
-   - **NeoVim:** [go.nvim](https://github.com/ray-x/go.nvim) is a great plugin
+### Use `--help`
 
-#### Nix develop (optional)
+To make the most out of the `gwa` tool, you can use the `--help` option to get detailed information on its various commands and options. Here's how you can use it:
 
-Instead of installing Go on your system you can alternatively use Nix to manage Go and other dependencies for you. This option assumes you already running NixOS or have Nix installed.
+1. **General Help**: To get an overview of all available commands, run:
+    ```sh
+       gwa --help
+    ```
+    This will list all the primary commands and provide a brief description of each.
+
+2. **Command-Specific Help**: To get detailed information about a specific command, use `--help` with the command in question. For example, if you want to learn more about the `gateway` command, you can run:
+    ```sh
+       gwa gateway --help
+    ```
+    This will provide detailed information about the `gateway` command, including its syntax, options, and examples.
 
-Simply run `$ nix develop` in the project root. This will pull all the dependencies needed to work on this project. Remember to run `exit` to leave the Nix shell when done.
+### Online documentation
 
-## Deployment
+Explore `gwa` commands in an easy-to-read reference format on the DevHub [CLI commands page](https://developer.gov.bc.ca/docs/default/component/aps-infra-platform-docs/reference/gwa-commands/).
 
-Details on how the deployment process work are coming soon as we migrate codebase languages.
+The content on this page is the same as the `--help` output.
 
-Make sure you have GoReleaser installed to test locally.
+## Support
 
-###### Tip
+If you need support or have any questions about using `gwa`, you can reach out to our team in the following ways:
 
-A dry-run of the build process can be executed by running `$ just release`. This will compile your source code into a `/dist` folder where you can run any platform's executable.
+### Rocket.Chat
 
-## Installation
+Rocket.Chat is a community platform where you can connect with our team and other users.
+Create an account on [Rocket.Chat](https://docs.developer.gov.bc.ca/join-bc-rocket-chat/) and join the [#aps-ops](https://chat.developer.gov.bc.ca/channel/aps-ops) channel. In this channel, you can:
 
-Currently `gwa` is only installable by building from source. The releases page will be updated one it's ready.
+- Ask questions
+- Share feedback
+- Get real-time support
+- Engage with other users who might have similar questions or use cases
 
-To install locally you can follow the first 2 steps in Development above, then run
+### GitHub issue tracker
 
-```sh
-$ just install
-...
-$  gwa-cli
-gwa version 2.0.0-beta
-```
+Alternatively, if you prefer asynchronous communication or need to report a bug, request a feature, or provide feedback, please use our GitHub [issue tracker](https://github.com/bcgov/gwa-cli/issues). On our GitHub issue tracker, you can:
 
-#### Completions
+- File new issues for bugs or feature requests
+- Track the status of reported issues
+- Contribute to discussions on existing issues
+- View the roadmap and planned enhancements
 
-Shell completions for all the commands ships with each version. Completions allow you to tab while entering commands to cycle though a list of possible commands.
+By using either of these methods, our team will be able to assist you promptly and effectively. We are committed to ensuring you have a positive experience with `gwa` and are here to answer any questions you might have.
 
-To install completions, run this after installing, using `zsh` for example:
+## Want to contribute?
 
-```sh
-$ gwa-cli completion zsh --help
-$ gwa-cli completion zsh | pbcopy
-```
+See [CONTRIBUTING.md](https://github.com/bcgov/gwa-cli/blob/main/contribute.md) for more info on how to make contributions to this project.
 
-Then follow the instructions from the help command and paste the output where it needs to live. Bash, Fish and Powershell are also supported.
diff --git a/build/gen-docs.go b/build/gen-docs.go
@@ -19,7 +19,10 @@ func main() {
 
 func writeDocument(rootCmd *cobra.Command) string {
 	var output strings.Builder
-	output.WriteString("# GWA CLI Commands\n\n")
+	output.WriteString("---\n")
+	output.WriteString("title: GWA CLI Commands\n")
+	output.WriteString("---\n\n")
+	output.WriteString("<!-- NOTE: This file is generated from gwa-cli, do not edit directly -->\n\n")
 	output.WriteString(fmt.Sprintf("%s\n", rootCmd.Long))
 
 	for _, cmd := range rootCmd.Commands() {

diff --git a/build/gen-docs_test.go b/build/gen-docs_test.go
@@ -24,7 +24,7 @@ func TestWriteDocument(t *testing.T) {
 	configCmd.AddCommand(configGetCmd)
 	rootCmd.AddCommand(configCmd)
 	output := writeDocument(rootCmd)
-	expect := "# GWA CLI Commands\n\nThis is a long title\n\n## config\n\n**Usage:** `gwa config`\n\n\n### config.get\n\n**Usage:** `gwa config get`\n\n"
+	expect := "---\ntitle: GWA CLI Commands\n---\n\n<!-- NOTE: This file is generated from gwa-cli, do not edit directly -->\n\nThis is a long title\n\n## config\n\n**Usage:** `gwa config`\n\n\n### config.get\n\n**Usage:** `gwa config get`\n\n"
 	assert.Equal(t, expect, output)
 }
 

diff --git a/cmd/apply.go b/cmd/apply.go
@@ -100,7 +100,11 @@ func (o *ApplyOptions) Parse() error {
 			}
 		}
 	}
-	o.output = append([]interface{}{gatewayService}, o.output...)
+
+	// Only append gatewayService if it has configurations
+	if len(gatewayService.Config) > 0 {
+		o.output = append([]interface{}{gatewayService}, o.output...)
+	}
 10000
	return nil
 }
 
@@ -142,25 +146,31 @@ $ gwa apply --input gw-config.yaml
 			if err != nil {
 				return err
 			}
-			pkg.Info("Namespace:" + ctx.Namespace)
+			pkg.Info("Gateway:" + ctx.Gateway)
 
 			counter := &PublishCounter{}
+			printBlankLine := false
+			var errors []string // Collect error messages here
 
 			for _, config := range opts.output {
 				switch c := config.(type) {
 				case GatewayService:
+					printBlankLine = true
 					fmt.Println()
 					fmt.Printf("↑ Publishing Gateway Services")
 					res, err := PublishGatewayService(ctx, c.Config)
 					if err != nil {
 						counter.AddFailed()
 						fmt.Print("\r")
 						fmt.Printf("%s Gateway Services publish failed\n", pkg.Times())
-						pkg.Error(fmt.Sprintf("Publish Error: %v", err))
+						errorMessage := fmt.Sprintf("[GatewayService]: %v", err)
+						pkg.Error(errorMessage)
+						errors = append(errors, errorMessage)
 						break
 					}
 
 					counter.AddSuccess()
+					fmt.Println()
 					fmt.Printf("%s Gateway Services published\n", pkg.Checkmark())
 					fmt.Println(res.Results)
 					fmt.Print("\r")
@@ -172,13 +182,19 @@ $ gwa apply --input gw-config.yaml
 					break
 
 				case Resource:
+					if !printBlankLine {
+						fmt.Println()
+						printBlankLine = true
+					}
 					fmt.Printf("↑ [%s] %s", c.Kind, c.Config["name"])
 					result, err := PublishResource(ctx, c.Config, c.GetAction())
 					if err != nil {
 						counter.AddFailed()
 						fmt.Print("\r")
 						fmt.Printf("%s [%s] %s failed\n", pkg.Times(), c.Kind, c.Config["name"])
-						pkg.Error(fmt.Sprintf("Resource Error: %v", err))
+						errorMessage := fmt.Sprintf("Resource [%s] %s: %v", c.Kind, c.Config["name"], err)
+						pkg.Error(errorMessage)
+						errors = append(errors, errorMessage)
 						break
 					}
 
@@ -192,11 +208,19 @@ $ gwa apply --input gw-config.yaml
 			fmt.Println()
 			fmt.Println(counter.Print())
 
+			if len(errors) > 0 {
+				fmt.Println()
+				fmt.Println(pkg.Times(), pkg.PrintError("Errors encountered"))
+				for _, errMsg := range errors {
+					fmt.Println(errMsg)
+				}
+			}
+
 			return nil
 		},
 	}
 
-	applyCmd.Flags().StringVarP(&opts.input, "input", "i", "gw-config.yml", "YAML file containing your configuration")
+	applyCmd.Flags().StringVarP(&opts.input, "input", "i", "", "YAML file containing your configuration")
 	applyCmd.MarkFlagRequired("input")
 
 	return applyCmd
@@ -216,7 +240,7 @@ func PublishResource(ctx *pkg.AppContext, doc map[string]interface{}, arg string
 	if err != nil {
 		return "", err
 	}
-	route := fmt.Sprintf("/ds/api/%s/namespaces/%s/%ss", ctx.ApiVersion, ctx.Namespace, arg)
+	route := fmt.Sprintf("/ds/api/%s/gateways/%s/%ss", ctx.ApiVersion, ctx.Gateway, arg)
 	URL, _ := ctx.CreateUrl(route, nil)
 	request, err := pkg.NewApiPut[PutResponse](ctx, URL, bytes.NewBuffer(body))
 	if err != nil {