fix: update logfmt to pass OpsLevel Platinum level (#10)

getoutreach · Oct 20, 2022 · 3b66e23 · 3b66e23
1 parent e58aa18
commit 3b66e23
Show file tree

Hide file tree

Showing 27 changed files with 477 additions and 505 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -2,7 +2,7 @@
 # syntax, such as anchors, will be fixed automatically.
 version: 2.1
 orbs:
-  shared: getoutreach/shared@2.2.0
+  shared: getoutreach/shared@2.5.1
 
 # Extra contexts to expose to all jobs below
 contexts: &contexts
@@ -14,70 +14,72 @@ contexts: &contexts
   - opslevel-credentials
   - vault-dev
   - confluence
-  ###Block(extraContexts)
+  - circleci-credentials
+  ## <<Stencil::Block(extraContexts)>>
 
-  ###EndBlock(extraContexts)
+  ## <</Stencil::Block>>
+
+# Branches used for releasing code, pre-release or not
+release_branches: &release_branches # Release branch
+  - release
+  # Pre-releases branch
+  - "main"
 
 jobs:
   {}
-  ###Block(circleJobs)
+  ## <<Stencil::Block(circleJobs)>>
 
-  ###EndBlock(circleJobs)
+  ## <</Stencil::Block>>
 
   ### Start jobs inserted by other modules
   ### End jobs inserted by other modules
 
 workflows:
   version: 2
-  ###Block(circleWorkflows)
+  ## <<Stencil::Block(circleWorkflows)>>
 
-  ###EndBlock(circleWorkflows)
+  ## <</Stencil::Block>>
 
   ### Start workflows inserted by other modules
   ### End workflows inserted by other modules
 
   release:
     jobs:
-      ###Block(circleWorkflowJobs)
+      ## <<Stencil::Block(circleWorkflowJobs)>>
 
-      ###EndBlock(circleWorkflowJobs)
+      ## <</Stencil::Block>>
       ### Start jobs inserted by other modules
       ### End jobs inserted by other modules
       - shared/release: &release
           dryrun: false
           context: *contexts
-          ###Block(circleReleaseExtra)
+          ## <<Stencil::Block(circleReleaseExtra)>>
 
-          ###EndBlock(circleReleaseExtra)
+          ## <</Stencil::Block>>
           requires:
-            ###Block(circleReleaseRequires)
+            ## <<Stencil::Block(circleReleaseRequires)>>
 
-            ###EndBlock(circleReleaseRequires)
+            ## <</Stencil::Block>>
             - shared/test
           filters:
             branches:
-              only:
-                - master
-                - main
-                - release
-      # Dryrun release for PRs
+              only: *release_branches
+
+      # Dryrun release for PRs.
       - shared/release:
           <<: *release
           dryrun: true
           filters:
             branches:
-              ignore:
-                - master
-                - main
-                - release
+              ignore: *release_branches
       - shared/test:
           context: *contexts
           app_name: logfmt
           ### Start parameters inserted by other modules
           ### End parameters inserted by other modules
-          ###Block(circleTestExtra)
+          ## <<Stencil::Block(circleTestExtra)>>
 
-          ###EndBlock(circleTestExtra)
+          ## <</Stencil::Block>>
 
       - shared/publish_docs:
           context: *contexts
@@ -86,23 +88,15 @@ workflows:
               ignore: /.*/
             tags:
               only: /v[0-9]+(\.[0-9]+)*(-.*)*/
-      - shared/finalize-coverage:
-          context: *contexts
-          requires:
-            - shared/e2e
-            - shared/test
       - shared/e2e:
           context: *contexts
-          ###Block(circleE2EExtra)
+          ## <<Stencil::Block(circleE2EExtra)>>
 
-          ###EndBlock(circleE2EExtra)
+          ## <</Stencil::Block>>
       - shared/docker:
           context: *contexts
           filters:
             branches:
-              ignore:
-                - master
-                - main
-                - release
+              ignore: *release_branches
             tags:
               only: /v\d+(\.\d+)*(-.*)*/
diff --git a/.editorconfig b/.editorconfig
@@ -12,6 +12,6 @@ indent_style = tab
 indent_style = space
 indent_size  = 2
 
-###Block(editorconfig)
+## <<Stencil::Block(editorconfig)>>
 
-###EndBlock(editorconfig)
+## <</Stencil::Block>>
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,6 +1,6 @@
 # See https://help.github.com/articles/about-codeowners/
 * @getoutreach/fnd-dt
 
-###Block(customCodeowners)
+## <<Stencil::Block(customCodeowners)>>
 
-###EndBlock(customCodeowners)
+## <</Stencil::Block>>
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,13 +1,18 @@
 version: 2
 updates:
+  # Golang dependencies
   - package-ecosystem: "gomod"
     directory: "/"
     schedule:
       interval: "daily"
-    # Bootstrap managed dependencies
+    # stencil-golang managed dependencies
     ignore:
       - dependency-name: github.com/getoutreach/gobox
       - dependency-name: github.com/urfave/cli/v2
+      - 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
 
   # Ignore semantic-release, this code is only executed in CI.
   - package-ecosystem: "npm"
@@ -17,5 +22,6 @@ updates:
     ignore:
       - dependency-name: "*"
 
-  ###Block(dependabotPackageManagers)
-  ###EndBlock(dependabotPackageManagers)
+  ## <<Stencil::Block(dependabotPackageManagers)>>
+
+  ## <</Stencil::Block>>
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,26 +1,29 @@
 <!--
   !!!! README !!!! Please fill this out.
 
-  Please follow the PR naming conventions:
+  Please follow the PR naming conventions: 
   https://outreach-io.atlassian.net/wiki/spaces/EN/pages/1902444645/Conventional+Commits
 -->
 
-<!-- A short description of what your PR does and what it solves. -->
 
+<!-- A short description of what your PR does and what it solves. -->
 ## What this PR does / why we need it
 
-<!--- Block(jiraPrefix) --->
+
+
+<!-- <<Stencil::Block(jiraPrefix)>> -->
 
 ## Jira ID
 
 [XX-XX]
 
-<!--- EndBlock(jiraPrefix) --->
+<!-- <</Stencil::Block>> -->
 
 <!-- Notes that may be helpful for anyone reviewing this PR -->
-
 ## Notes for your reviewers
 
-<!--- Block(custom) -->
 
-<!--- EndBlock(custom) -->
+
+<!-- <<Stencil::Block(custom)>> -->
+
+<!-- <</Stencil::Block>> -->
diff --git a/.gitignore b/.gitignore
@@ -60,6 +60,6 @@ Pulumi.*.yaml
 # Documentation output
 /apidocs
 
-###Block(extras)
+## <<Stencil::Block(extras)>>
 
-###EndBlock(extras)
+## <</Stencil::Block>>
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,7 @@
+# Ignore all markdown formatting by default. If you want prettier to format
+# your markdown files, manually include them by adding prefixed ! entries.
+*.md
+
+## <<Stencil::Block(prettierignoreExtras)>>
+
+## <</Stencil::Block>>
diff --git a/.releaserc.yaml b/.releaserc.yaml
@@ -24,6 +24,6 @@ plugins:
         - "dist/*.tar.gz"
         - "dist/checksums.txt"
 
-  ### Block(customReleasePlugins)
+  ## <<Stencil::Block(customReleasePlugins)>>
 
-  ### EndBlock(customReleasePlugins)
+  ## <</Stencil::Block>>
diff --git a/.tool-versions b/.tool-versions
@@ -1,11 +1,17 @@
 # This file contains tool versions for use with asdf
-golang 1.17.9
+# 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>>
+golang 1.19
 nodejs 16.13.0
 terraform 0.13.5
-ruby 2.6.6
-protoc 3.19.1
-# Note: Versions in this block override the above. Be EXTREMELY
-# CAREFUL with this. If you override a standard version you are
-# reducing compatibility guarantees.
-###Block(toolver)
-###EndBlock(toolver)
+ruby 2.7.5
+protoc 21.5
+# 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>>
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -4,18 +4,17 @@
     "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"
 
     // Please consider contributing back all recommended
-    // extensions to bootstrap!
-    ///Block(extensions)
+    // extensions to stencil!
+    // <<Stencil::Block(extensions)>>
 
-    ///EndBlock(extensions)
+    // <</Stencil::Block>>
   ]
 }
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -20,27 +20,27 @@
       "debugAdapter": "dlv-dap",
       "request": "attach",
       "mode": "remote",
-      ///Block(vscodeRemoteDebug)
+      // <<Stencil::Block(vscodeRemoteDebug)>>
       "host": "127.0.0.1",
       "port": 42097,
-      ///EndBlock(vscodeRemoteDebug)
+      // <</Stencil::Block>>
       "substitutePath": [
         {
           "from": "${workspaceRoot}",
           "to": "/home/dev/app"
         },
         {
-          "from": "${env:HOME}/.asdf/installs/golang/1.17.9/packages/pkg/mod",
+          "from": "${env:HOME}/.asdf/installs/golang/1.19/packages/pkg/mod",
           "to": "/tmp/cache/go/mod/"
         },
         {
-          "from": "${env:HOME}/.asdf/installs/golang/1.17.9/go/src",
-          "to": "/home/dev/.asdf/installs/golang/1.17.9/go/src"
+          "from": "${env:HOME}/.asdf/installs/golang/1.19/go/src",
+          "to": "/home/dev/.asdf/installs/golang/1.19/go/src"
         }
       ]
     }
-    ///Block(vscodeLaunchConfigs)
+    // <<Stencil::Block(vscodeLaunchConfigs)>>
 
-    ///EndBlock(vscodeLaunchConfigs)
+    // <</Stencil::Block>>
   ]
 }
diff --git a/.vscode/private.env b/.vscode/private.env
@@ -1,6 +1,6 @@
 MY_NAMESPACE="logfmt--bento1a"
 OUTREACH_ACCOUNTS_BASE_URL="https://accounts.outreach-dev.com"
 OUTREACH_DOMAIN="outreach-dev.com"
-///Block(vscodeEnvVars)
+// <<Stencil::Block(vscodeEnvVars)>>
 
-///EndBlock(vscodeEnvVars)
+// <</Stencil::Block>>
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,18 +1,16 @@
 {
   // Please consider contributing back all added
-  // settings to bootstrap!
-  ///Block(settings)
+  // settings to stencil!
+  // <<Stencil::Block(settings)>>
 
-  ///EndBlock(settings)
+  // <</Stencil::Block>>
   "go.lintTool": "golangci-lint",
   "go.lintFlags": [],
   "go.formatTool": "goimports",
   "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"
   },
   "go.buildTags": "or_dev",
   "go.testTags": "or_test,or_int,or_e2e",

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,20 +1,20 @@
 # logfmt
 
-<!--- Block(customGeneralInformation) -->
+<!-- <<Stencil::Block(customGeneralInformation)>> -->
 
-<!--- EndBlock(customGeneralInformation) -->
+<!-- <</Stencil::Block>> -->
 
 ## Prerequisites
 
-<!--- Block(customPrerequisites) -->
+<!-- <<Stencil::Block(customPrerequisites)>> -->
 
-<!--- EndBlock(customPrerequisites) -->
+<!-- <</Stencil::Block>> -->
 
 ## Building and Testing
 
-<!--- Block(customBuildingAndTesting) -->
+<!-- <<Stencil::Block(customBuildingAndTesting)>> -->
 
-<!--- EndBlock(customBuildingAndTesting) -->
+<!-- <</Stencil::Block>> -->
 
 ### Replacing a Remote Version of the a Package with Local Version
 

diff --git a/Makefile b/Makefile
@@ -4,6 +4,6 @@ _ := $(shell ./scripts/devbase.sh)
 
 include .bootstrap/root/Makefile
 
-###Block(targets)
+## <<Stencil::Block(targets)>>
 
-###EndBlock(targets)
+## <</Stencil::Block>>