chore(stencil): stencil for gcr -> ecr (#12)

* chore(stencil): stencil for gcr -> ecr

* linter

* remove release channel for stencil modules

* skip docker build

* add missing docker file

* fix docker build issues

Author: evadnoob

.circleci/config.yml

@@ -2,26 +2,54 @@
 # syntax, such as anchors, will be fixed automatically.
 version: 2.1
 orbs:
-  shared: getoutreach/[email protected]
+  shared: getoutreach/[email protected]
+  queue: eddiewebb/[email protected]
+  ## <<Stencil::Block(CircleCIExtraOrbs)>>
+
+  ## <</Stencil::Block>>
+
+parameters:
+  rebuild_cache:
+    type: boolean
+    default: false
+  ## <<Stencil::Block(CircleCIExtraParams)>>
+
+  ## <</Stencil::Block>>
 
 # Extra contexts to expose to all jobs below
 contexts: &contexts
   - aws-credentials
   - ghaccesstoken
   - docker-registry
   - npm-credentials
-  - prismacloud-credentials
-  - opslevel-credentials
+  - box
   - vault-dev
   - confluence
+  - circleci-credentials
+  - tray-webhooks
+  - wizcli
   ## <<Stencil::Block(extraContexts)>>
 
   ## <</Stencil::Block>>
 
+# Test configs to pass to test and cache jobs
+test: &test
+  context: *contexts
+  app_name: csv
+  ### Start parameters inserted by other modules
+  ### End parameters inserted by other modules
+  ## <<Stencil::Block(circleTestExtra)>>
+
+  ## <</Stencil::Block>>
+
 # Branches used for releasing code, pre-release or not
 release_branches: &release_branches
   - "main"
 
+## <<Stencil::Block(circleAnchorExtra)>>
+
+## <</Stencil::Block>>
+
 jobs:
   {}
   ## <<Stencil::Block(circleJobs)>>
@@ -40,7 +68,27 @@ workflows:
   ### Start workflows inserted by other modules
   ### End workflows inserted by other modules
 
+  rebuild-cache:
+    triggers:
+      - schedule:
+          # Every day at 00:00 UTC.
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - main
+    jobs:
+      - shared/save_cache: *test
+
+  manual-rebuild-cache:
+    when: << pipeline.parameters.rebuild_cache >>
+    jobs:
+      - shared/save_cache: *test
+
   release:
+    when:
+      and:
+        - not: << pipeline.parameters.rebuild_cache >>
     jobs:
       ## <<Stencil::Block(circleWorkflowJobs)>>
 
@@ -60,45 +108,37 @@ workflows:
             - shared/test
           filters:
             branches:
-              only: *release_branches
-
-      # Dryrun release for PRs.
-      - shared/release:
-          <<: *release
+              only: main
+      # Dryrun for PRs
+      - shared/pre-release: &pre-release
           dryrun: true
+          context: *contexts
+          ## <<Stencil::Block(circlePreReleaseDryRunExtra)>>
+
+          ## <</Stencil::Block>>
+          requires:
+            ## <<Stencil::Block(circlePreReleaseDryRunRequires)>>
+
+            ## <</Stencil::Block>>
+            - shared/test
           filters:
             branches:
               ignore: *release_branches
       - shared/test:
-          context: *contexts
-          app_name: csv
-          ### Start parameters inserted by other modules
-          ### End parameters inserted by other modules
-          ## <<Stencil::Block(circleTestExtra)>>
+          <<: *test
+          ## <<Stencil::Block(circleSharedTestExtra)>>
 
           ## <</Stencil::Block>>
-
       - shared/publish_docs:
           context: *contexts
           filters:
             branches:
-              ignore: /.*/
+              only:
+                - main
             tags:
-              only: /v[0-9]+(\.[0-9]+)*(-.*)*/
-      - shared/finalize-coverage:
-          context: *contexts
-          requires:
-            - shared/e2e
-            - shared/test
+              only: /v\d+(\.\d+)*(-.*)*/
       - shared/e2e:
           context: *contexts
           ## <<Stencil::Block(circleE2EExtra)>>
 
           ## <</Stencil::Block>>
-      - shared/docker:
-          context: *contexts
-          filters:
-            branches:
-              ignore: *release_branches
-            tags:
-              only: /v\d+(\.\d+)*(-.*)*/

.github/dependabot.yml

@@ -8,10 +8,11 @@ updates:
     # stencil-golang managed dependencies
     ignore:
       - dependency-name: github.com/getoutreach/gobox
+      - dependency-name: github.com/getoutreach/stencil-golang/pkg
       - dependency-name: github.com/getoutreach/mint
-      - dependency-name: github.com/getoutreach/httpx
       - dependency-name: github.com/getoutreach/services
       - dependency-name: github.com/getoutreach/datastores/v2
+      - dependency-name: github.com/getoutreach/httpx
 
   # Ignore semantic-release, this code is only executed in CI.
   - package-ecosystem: "npm"

.github/pull_request_template.md

@@ -1,16 +1,17 @@
 <!--
   !!!! README !!!! Please fill this out.
 
-  Please follow the PR naming conventions: 
-  https://outreach-io.atlassian.net/wiki/spaces/EN/pages/1902444645/Conventional+Commits
+  Please follow conventional commit naming conventions:
+
+  https://www.conventionalcommits.org/en/v1.0.0/#summary
 -->
 
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for additional information on contributing to this repository!
 
 <!-- A short description of what your PR does and what it solves. -->
 ## What this PR does / why we need it
 
 
-
 <!-- <<Stencil::Block(jiraPrefix)>> -->
 ## Jira ID
 
@@ -20,8 +21,6 @@
 <!-- Notes that may be helpful for anyone reviewing this PR -->
 ## Notes for your reviewers
 
-
-
 <!-- <<Stencil::Block(custom)>> -->
 
 <!-- <</Stencil::Block>> -->

.github/workflows/pull_request-shared-actions.yaml

@@ -1,5 +1,7 @@
 name: Pull Request Shared Actions
-on: pull_request
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, edited] # Add edited to the default list for title changes event
 
 jobs:
   conventional_commit:

.gitignore

@@ -14,6 +14,7 @@ TAGS
 *.sublime-project
 *.sublime-workspace
 .\#*
+.dir-locals.el
 
 # Test binary, build with "go test -c"
 *.test
@@ -60,6 +61,12 @@ Pulumi.*.yaml
 # Documentation output
 /apidocs
 
+# Terraform lock files
+.terraform.lock.hcl
+
+### Start ignores inserted by other modules
+### End ignores inserted by other modules
+
 ## <<Stencil::Block(extras)>>
 
 ## <</Stencil::Block>>

.tool-versions

@@ -1,11 +1,16 @@
 # This file contains tool versions for use with asdf
-golang 1.19
-nodejs 16.13.0
-terraform 0.13.5
-ruby 2.7.5
+# Note: Versions in this block override the default versions below.
+# Be EXTREMELY CAREFUL with this. If you override a standard version
+# you are reducing compatibility guarantees.
+## <<Stencil::Block(toolverOverride)>>
+## <</Stencil::Block>>
 protoc 21.5
-# Note: Versions in this block override the above. Be EXTREMELY
-# CAREFUL with this. If you override a standard version you are
-# reducing compatibility guarantees.
+nodejs 20.16.0
+terraform 1.5.7
+golang 1.23.4
+# Note: Versions in this block do not override the default versions above
+# but sometimes you have to declare additional versions of the same tool
+# while leaving the 'default' version intact for the infra.
+# The most common case is nodejs.
 ## <<Stencil::Block(toolver)>>
 ## <</Stencil::Block>>

.vscode/extensions.json

@@ -4,13 +4,13 @@
     "esbenp.prettier-vscode",
     "hashicorp.terraform",
     "golang.go",
-    "heptio.jsonnet",
-    "xrc-inc.jsonnet-formatter",
+    "Grafana.vscode-jsonnet",
     "timonwong.shellcheck",
     "zxh404.vscode-proto3",
     "redhat.vscode-yaml",
     "ms-azuretools.vscode-docker",
-    "foxundermoon.shell-format"
+    "foxundermoon.shell-format",
+    "WizCloud.wizcli-vscode"
 
     // Please consider contributing back all recommended
     // extensions to stencil!

.vscode/launch.json

@@ -24,20 +24,41 @@
       "host": "127.0.0.1",
       "port": 42097,
       // <</Stencil::Block>>
+      // Paths to replace when running the debugger. "from" is the host
+      // path and "to" is the path in the devspace.
       "substitutePath": [
         {
+          // Maps the workspace root (the repository directory) to the path that
+          // is compiled into the built binary. Note: This is not impacted by trimpath
+          // because devbase currently uses dlv to compile the source code.
+          // See: https://github.com/getoutreach/devbase/blob/main/shell/debug.sh#L72
           "from": "${workspaceRoot}",
           "to": "/home/dev/app"
         },
+        // Maps the go module cache on the host to the persistent volume used by devspaces.
+        // These should be the respective values of `go env GOMODCACHE`.
         {
-          "from": "${env:HOME}/.asdf/installs/golang/1.19/packages/pkg/mod",
-          "to": "/tmp/cache/go/mod/"
+          "from": "${env:HOME}/.asdf/installs/golang/1.23.4/packages/pkg/mod",
+          "to": "/home/dev/.asdf/installs/golang/1.23.4/packages/pkg/mod"
         },
         {
-          "from": "${env:HOME}/.asdf/installs/golang/1.19/go/src",
-          "to": "/home/dev/.asdf/installs/golang/1.19/go/src"
+          // Maps the standard library location on the host to the location in the devspace.
+          // This enables debugging standard library code.
+          "from": "${env:HOME}/.asdf/installs/golang/1.23.4/go/src",
+          "to": "/home/dev/.asdf/installs/golang/1.23.4/go/src"
         }
       ]
+    },
+    {
+      "name": "Attach to dev container (in binary mode)",
+      "type": "go",
+      "debugAdapter": "dlv-dap",
+      "request": "attach",
+      "mode": "remote",
+      // <<Stencil::Block(vscodeRemoteDebugDevspaceBinary)>>
+      "host": "127.0.0.1",
+      "port": 42097
+      // <</Stencil::Block>>
     }
     // <<Stencil::Block(vscodeLaunchConfigs)>>
 

.vscode/private.env

@@ -1,6 +1,4 @@
 MY_NAMESPACE="csv--bento1a"
-OUTREACH_ACCOUNTS_BASE_URL="https://accounts.outreach-dev.com"
-OUTREACH_DOMAIN="outreach-dev.com"
 // <<Stencil::Block(vscodeEnvVars)>>
 
 // <</Stencil::Block>>

.vscode/settings.json

@@ -10,12 +10,16 @@
   "go.useLanguageServer": true,
   "go.testEnvFile": "${workspaceFolder}/.vscode/private.env",
   "go.alternateTools": {
-    // This makes sure we use the correct version
-    // of golangci-lint in our editors.
-    "golangci-lint": "${workspaceFolder}/.bootstrap/shell/golangci-lint.sh"
+    "golangci-lint": "${workspaceFolder}/.bootstrap/shell/vscode/golang-linters.sh"
   },
+  // This is disabled because it causes version mismatches between the
+  // tools used/installed by asdf / stencil, and the ones updated by VSCode.
+  // In particular, this is a problem with newer versions of golangci-lint
+  // incompatible with older versions of Go.
+  "go.toolsManagement.autoUpdate": false,
   "go.buildTags": "or_dev",
   "go.testTags": "or_test,or_int,or_e2e",
+  "files.trimTrailingWhitespace": true,
   // This prevents 99% of issues with linters :)
   "editor.formatOnSave": true,
   "shellcheck.customArgs": ["-P", "SCRIPTDIR", "-x"],