fix: support all grc codecommit variants (#28)

ga-paul-t · web-flow · commit 5872e00a9ef3 · 2022-03-06T07:37:06.000Z
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Gemba Advantage
+# Copyright (c) 2022 Gemba Advantage
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
diff --git a/.github/stale.yml b/.github/stale.yml
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Gemba Advantage
+# Copyright (c) 2022 Gemba Advantage
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Gemba Advantage
+# Copyright (c) 2022 Gemba Advantage
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -36,19 +36,32 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version: 1.17
+      - name: Cache Go
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/go/pkg/mod
+            ~/.cache/go-build
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Install Task
+        uses: arduino/setup-task@v1
       - name: Lint
         uses: golangci/golangci-lint-action@v3.1.0
         with:
           skip-go-installation: true
       - name: Test
-        run: make test
+        run: task test
       - name: Code Coverage
         uses: codecov/codecov-action@v2.0.3
       - name: Build
-        run: make build
+        run: task build
       - name: Tag
         if: github.ref == 'refs/heads/main'
-        uses: gembaadvantage/uplift-action@v1
+        uses: gembaadvantage/uplift-action@v2.0.1
+        with:
+          args: tag
         env:
           GITHUB_TOKEN: ${{ secrets.GH_UPLIFT }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Gemba Advantage
+# Copyright (c) 2022 Gemba Advantage
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -34,7 +34,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version: 1.17
       - name: Import GPG key
         id: import_gpg
         uses: hashicorp/ghaction-import-gpg@v2.1.0
diff --git a/.golangci.yml b/.golangci.yml
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Gemba Advantage
+# Copyright (c) 2022 Gemba Advantage
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Gemba Advantage
+# Copyright (c) 2022 Gemba Advantage
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -61,10 +61,13 @@ archives:
     files:
       - README.md
       - LICENSE
+
 checksum:
   name_template: "{{ .ProjectName }}_{{ .Tag }}_checksums.txt"
+
 signs:
   - artifacts: checksum
+
 brews:
   - name: git-remote-codecommit
     tap:
@@ -79,10 +82,19 @@ brews:
     test: |
       installed_version = shell_output("#{bin}/git-remote-codecommit version --short 2>&1")
       assert_match "v#{version}", installed_version
+
 scoop:
   bucket:
     owner: gembaadvantage
     name: scoops
   homepage: "https://github.com/gembaadvantage/git-remote-codecommit"
   description: "A git remote helper that removes the need for dedicated CodeCommit user credentials"
   license: MIT
+
+rigs:
+  - rig:
+      owner: gembaadvantage
+      name: fish-food
+    homepage: "https://github.com/gembaadvantage/git-remote-codecommit"
+    description: "A git remote helper that removes the need for dedicated CodeCommit user credentials"
+    license: MIT
diff --git a/.uplift.yml b/.uplift.yml
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Gemba Advantage
+# Copyright (c) 2022 Gemba Advantage
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Gemba Advantage
+Copyright (c) 2022 Gemba Advantage
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -35,9 +35,10 @@ curl https://raw.githubusercontent.com/gembaadvantage/git-remote-codecommit/main
 
 Clone the repository using your standard git syntax, but provide the clone URL using the `codecommit` protocol format of:
 
-```text
-codecommit::<REGION>://<PROFILE>@<REPOSITORY>
-```
+- `codecommit://repository`
+- `codecommit://profile@repository`
+- `codecommit::region://repository`
+- `codecommit::region://profile@repository`
 
 ```sh
 $ git clone codecommit::eu-west-1://repository
@@ -52,7 +53,7 @@ Both `git pull` and `git push` operations will behave as normal.
 
 ### AWS Named Profile
 
-Depending on your chosen authentication mechansim, you may need to provide an AWS named profile to authenticate with CodeCommit. To do this, provide the named profile, suffixed with an `@`, before the repository name.
+Depending on your chosen authentication mechanism, you may need to provide an AWS named profile to authenticate with CodeCommit. To do this, prefix your repository name with `profile@`.
 
 ```sh
 git clone codecommit::eu-west-1://profile@repository
diff --git a/Taskfile.yaml b/Taskfile.yaml
@@ -0,0 +1,65 @@
+# Copyright (c) 2022 Gemba Advantage
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# in the Software without restriction, including without limitation the rights
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+version: "3"
+
+vars:
+  BINDIR: bin
+  BINNAME: git-remote-codecommit
+  GIT_COMMIT:
+    sh: git rev-parse HEAD
+  GIT_SHA:
+    sh: git rev-parse --short HEAD
+  GIT_BRANCH:
+    sh: git branch --show-current
+  LDFLAGS: >
+    -X github.com/gembaadvantage/git-remote-codecommit/internal/version.version=dev-{{.GIT_SHA}}
+    -X github.com/gembaadvantage/git-remote-codecommit/internal/version.gitCommit={{.GIT_COMMIT}}
+    -X github.com/gembaadvantage/git-remote-codecommit/internal/version.gitBranch={{.GIT_BRANCH}}
+    -X github.com/gembaadvantage/git-remote-codecommit/internal/version.buildDate={{now | date "2006-01-02T15:04:05Z07:00"}}
+
+tasks:
+  default:
+    desc: Runs all of the default tasks
+    cmds:
+      - task: clean
+      - task: lint
+      - task: test
+      - task: build
+
+  build:
+    desc: Build the git-remote-codecommit binary
+    cmds:
+      - go build -ldflags '-s -w {{.LDFLAGS}}' -o '{{.BINDIR}}/{{.BINNAME}}' ./cmd/grc
+
+  test:
+    desc: Run the tests
+    cmds:
+      - go test -race -vet=off -p 1 -covermode=atomic -coverprofile=coverage.out ./...
+
+  lint:
+    desc: Lint the code using golangci
+    cmds:
+      - golangci-lint run --timeout 5m0s
+
+  clean:
+    desc: Remove any built artifacts
+    cmds:
+      - rm -rf {{.BINDIR}}
diff --git a/cmd/grc/main.go b/cmd/grc/main.go
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2021 Gemba Advantage
+Copyright (c) 2022 Gemba Advantage
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/cmd/grc/root.go b/cmd/grc/root.go
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2021 Gemba Advantage
+Copyright (c) 2022 Gemba Advantage
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -56,7 +56,7 @@ func newRootCmd(out io.Writer, args []string) *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			opts.Cmd = args[0]
 
-			// Prefix protocol, as it will have been stipped off by the git client
+			// Prefix protocol, as it will have been stripped off by the git client
 			opts.RemoteURL = "codecommit::" + args[1]
 
 			return opts.Run(out)
@@ -85,7 +85,7 @@ func (o gitOptions) Run(out io.Writer) error {
 	}
 
 	// Translate and then sign the RemoteURL
-	grcURL, err := translate.FromGrc(o.RemoteURL)
+	grcURL, err := translate.FromGRC(o.RemoteURL)
 	if err != nil {
 		return err
 	}
diff --git a/cmd/grc/root_test.go b/cmd/grc/root_test.go
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2021 Gemba Advantage
+Copyright (c) 2022 Gemba Advantage
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/cmd/grc/version.go b/cmd/grc/version.go
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2021 Gemba Advantage
+Copyright (c) 2022 Gemba Advantage
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/go.mod b/go.mod
@@ -4,7 +4,7 @@ go 1.17
 
 require (
 	github.com/aws/aws-sdk-go-v2/config v1.14.0
-	github.com/gembaadvantage/codecommit-sign v1.1.0
+	github.com/gembaadvantage/codecommit-sign v1.3.1
 	github.com/spf13/cobra v1.3.0
 )
 
diff --git a/go.sum b/go.sum
diff --git a/internal/version/build.go b/internal/version/build.go
diff --git a/scripts/install b/scripts/install

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Copyright (c) 2021 Gemba Advantage`
	`1`	`+# Copyright (c) 2022 Gemba Advantage`
`2`	`2`	`#`
`3`	`3`	`# Permission is hereby granted, free of charge, to any person obtaining a copy`
`4`	`4`	`# of this software and associated documentation files (the "Software"), to deal`