Refactor 1

.custom-hooks/pre-commit

@@ -1,52 +1,18 @@
 #!/usr/bin/env sh
 
-# # Redirect output to stderr.
-# exec 1>&2
+PROJECT_BASE_PATH=$(git rev-parse --show-toplevel)
+cd "$PROJECT_BASE_PATH" || exit 0
 
-# # Check for unstaged changes to tracked files.
-# echo "Checking for unstaged changes to tracked files..."
-# if git diff --exit-code --quiet --ignore-submodules --cached
-# then
-#     # No unstaged changes to tracked files, so we can proceed.
-#     echo "No unstaged changes detected."
-# else
-#     # Unstaged changes to tracked files. We should stash them.
-#     echo "Stashing unstaged changes to tracked files..."
-#     git stash --keep-index --include-untracked
-# fi
+GO_FILES_STAGED=$(git diff --name-only --cached | grep -c .go)
 
-# # Run golangci-lint on the staged files.
-# echo "Running golangci-lint on staged files..."
-# STAGED_GO_FILES=$(git diff --cached --name-only -- '*.go')
-# if [ "$STAGED_GO_FILES" != "" ]
-# then
-#     # Run golangci-lint on the staged files.
-#     golangci-lint run $STAGED_GO_FILES
-#     LINT_EXIT_CODE=$?
-# else
-#     # No Go files staged.
-#     echo "No Go files staged for commit."
-#     LINT_EXIT_CODE=0
-# fi
+if [ -n "$GO_FILES_STAGED" ] && [ "$GO_FILES_STAGED" != "0" ]; then
+    GOLINT_BIN=$(which golangci-lint)
 
-# # Unstash changes to tracked files, if necessary.
-# if [ "$STASH_NAME" != "" ]
-# then
-#     echo "Unstashing unstaged changes to tracked files..."
-#     git stash pop
-# fi
+    if [ -n "$GOLINT_BIN" ]; then
+        LAST_COMMIT=$(git rev-parse HEAD)
 
-# # If the linter failed (non-zero exit code), exit with a failure status.
-# if [ $LINT_EXIT_CODE != 0 ]
-# then
-#     echo "golangci-lint found issues in the staged files."
-#     exit 1
-# fi
+        echo "[pre-commit] $GOLINT_BIN run -c ./.golangci.yaml --new-from-rev $LAST_COMMIT"
 
-# Otherwise, exit with a success status.
-exit 0
-
-# GO_FILES_STAGED=$(git diff --name-only --cached | grep .go | wc -l)
-# if [ ! -z $GO_FILES_STAGED ]; then
-#     golangci-lint run -c ./.golangci.yaml
-# fi
+        $GOLINT_BIN run -c ./.golangci.yaml --new-from-rev "$LAST_COMMIT"
+    fi
+fi

.env.example

@@ -0,0 +1,9 @@
+FRONTEND_PROJECT_PATH=
+LOCAL_BACKEND_PROJECT_PATH=
+
+TELEGRAM_API_KEY=
+TELEGRAM_CHAT_ID_1=
+TELEGRAM_CHAT_ID_2=
+
+SLACK_CHANNEL_1=
+SLACK_WEBHOOK_URL=

.github/dependabot.yml

@@ -6,22 +6,9 @@ updates:
     open-pull-requests-limit: 10
     schedule:
       interval: weekly
-    groups:
-      dev-dependencies:
-        - '*'
-      dependencies:
-        - '*'
-    labels:
-      - "dependencies"
-    allow:
-      - dependency-type: "direct"
 
   - package-ecosystem: "github-actions"
     directory: "/"
     open-pull-requests-limit: 10
     schedule:
       interval: weekly
-    labels:
-      - "dependencies"
-    allow:
-      - dependency-type: "direct"

.github/workflows/build-and-test.yml

@@ -1,43 +1,65 @@
-name: build
+name: build-and-test
 on:
   push:
-    branches: [main]
+    branches:
+      - main
     tags:
-      - 'v*'
+      - v*
+  pull_request:
+  pull_request_target:
+    types: [opened, edited]
 
-jobs:
-  build:
-    strategy:
-      matrix:
-        go-version: [~1.20]
-        os: [ubuntu-latest]
-
-    runs-on: ${{ matrix.os }}
+env:
+  GO_VERSION: "~1.20"
+  GO111MODULE: "on"
 
-    env:
-      GO111MODULE: "on"
+jobs:
+  test-build:
+    runs-on: ubuntu-latest
 
     steps:
-
       - name: Install Task
         uses: arduino/setup-task@v1
 
       - name: Install Go
         uses: actions/setup-go@v4
         with:
-          go-version: ${{ matrix.go-version }}
-          cache-dependency-path: ./go.sum
+          go-version: ${{ env.GO_VERSION }}
 
       - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Download Go modules
-        run: go mod download
+      - name: Download and tidy Go modules
+        run: task mod
 
       - name: Build Application
         id: build
-        run: task build
+        run: task build-stackup
+
+  run-tests:
+    runs-on: ubuntu-latest
 
-      - name: Run Tests
+    steps:
+      - name: Install Task
+        uses: arduino/setup-task@v1
+
+      - name: Install Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Download and tidy Go modules
+        run: task mod
+
+      - name: Run Tests with Coverage
+        run: go test -cover -coverprofile coverage.out -v ./lib/**
+
+      - name: Upload coverage reports to Codecov
         if: ${{success()}}
-        run: go test ./...
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.out

.github/workflows/dependabot-auto-merge.yml

@@ -17,15 +17,8 @@ jobs:
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
 
-      - name: Auto-merge Dependabot PRs for semver-minor updates
-        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-minor'}}
-        run: gh pr merge --auto --merge "$PR_URL"
-        env:
-          PR_URL: ${{github.event.pull_request.html_url}}
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-
-      - name: Auto-merge Dependabot PRs for semver-patch updates
-        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-patch'}}
+      - name: Auto-merge Dependabot PRs
+        if: ${{steps.metadata.outputs.update-type != 'version-update:semver-major'}}
         run: gh pr merge --auto --merge "$PR_URL"
         env:
           PR_URL: ${{github.event.pull_request.html_url}}

.github/workflows/run-goreleaser.yml

@@ -17,6 +17,8 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
+      matrix:
+        os: [ubuntu-latest]
       fail-fast: false
 
     steps:

.golangci.yaml

@@ -2,10 +2,10 @@
 run:
   # Timeout for analysis, e.g. 30s, 5m. Default: 1m
   timeout: 15s
-  modules-download-mode: mod
+  modules-download-mode: readonly
 
   # Include test files or not. Default: true
-  tests: false
+  tests: true
 
   # Which dirs to skip: issues from them won't be reported.
   # Can use regexp here: `generated.*`, regexp is applied on full path.
@@ -30,29 +30,20 @@ run:
   # we confidently recognize autogenerated files.
   # If it's not please let us know.
   # "/" will be replaced by current OS file path separator to properly work on Windows.
-  skip-files:
-    - tools/*.go
-    - tools/configure/*.go
 
   # Allow multiple parallel golangci-lint instances running; If false (default) - golangci-lint acquires file lock on start.
   allow-parallel-runners: true
-  concurrency: 4
-
+  concurrency: 8
 
 linters:
+  disable-all: true
   fast: true
-  disable:
-    - errcheck
-    - gosimple
-    - nestif
-    - staticcheck
-    - typecheck
-    - unused
   enable:
     - gocyclo
     - govet
     - maintidx
     - misspell
+    - unused
     - unparam
     #- errcheck
     #- funlen
@@ -72,7 +63,6 @@ severity:
   default-severity: warning
   case-sensitive: false
 
-
 linters-settings:
   gocyclo:
     min-complexity: 20
@@ -92,7 +82,6 @@ linters-settings:
       G302: "0644" # Maximum allowed permissions mode for os.OpenFile and os.Chmod - Default: "0600"
       G306: "0644" # Maximum allowed permissions mode for os.WriteFile and ioutil.WriteFile - Default: "0600"
 
-  # Show functions with maintainability index lower than N. A high index indicates better maintainability (opposite of complexity). - Default: 20
   maintidx:
     under: 25
 

README.md

@@ -56,7 +56,6 @@ Spin up your entire dev stack with one command.
     - [Initialization Script](#initialization-script)
   - [Setup](#setup)
   - [Building the project](#building-the-project)
-  - [Changelog](#changelog)
   - [Contributing](#contributing)
   - [Security Vulnerabilities](#security-vulnerabilities)
   - [Credits](#credits)
@@ -196,11 +195,12 @@ settings:
 
 The `domains` section of the configuration file is used to specify a list of domain names that can be accessed when downloading remote files
 or including remote files.  Wildcards are supported, such as `*.github.com`.  
-If the `domains` section is not specified, default values of `raw.githubusercontent.com` and `api.github.com` are used.
+If the `domains` section is not specified, default values of `raw.githubusercontent.com` and `api.github.com` are used for the allow list,
+and all other domains are blocked.
 
 The `hosts` section of `domains` allows the configuration of headers to send with requests to specific hosts. Hostnames may be fully-qualified
 hostnames, or may contain wildcards.  For example, `*.githubusercontent.com` will match `raw.githubusercontent.com` and `gist.githubusercontent.com`.
-If the `gateway` field is set to `allow`, the hostname will be added to the list of allowed domains automatically.
+If the `gateway` field is set to `allow`, the hostname will be added to the list of allowed domains automatically, and defaults to `true`.
 
 > The domain allow list is applied to all url access, including when `StackUp` checks to see if it is running the latest version,
 > or when sending anonymous opt-in analytics.
@@ -295,16 +295,21 @@ Included files can be specified with either a relative or absolute pathname.  Re
 
 ```yaml
 includes:
+  # include a remote file from github
   - url: gh:permafrost-dev/stackup/main/templates/remote-includes/containers.yaml
     verify: false # optional, defaults to true
 
   - url: gh:permafrost-dev/stackup/main/templates/remote-includes/node.yaml
     headers:
-      - 'Authorization: token $GITHUB_TOKEN' # headers to send with the request, can be javascript if wrapped in double braces
+      # headers to send with the request, javascript must be wrapped in double braces
+      - 'Authorization: token $GITHUB_TOKEN'
+      - '{{ "X-Some-Header: " + getEnv("GITHUB_TOKEN") }}'
 
-  - file: python.yaml # includes a local file
+  # include a local file
+  - file: python.yaml
 
-  - url: s3:127.0.0.1:9000/stackup-includes/python.yaml # includes a file from a minio bucket
+  # include a remote file from a minio/s3 bucket
+  - url: s3:127.0.0.1:9000/stackup-includes/python.yaml
     access-key: $S3_KEY # access key loaded from `.env` or `env` section
     secret-key: $S3_SECRET # secret key env loaded from `.env` or `env` section
     secure: false # optional, defaults to true
@@ -548,8 +553,8 @@ Many of the fields in a `Task` can be defined using javascript. To specify an ex
 | `binaryExists()`| `name: string`   | returns true if the specified binary exists in `$PATH`, otherwise false       |
 | `env()`      | `name: string`      | returns the string value of environment variable `name                        |
 | `exists()`   | `filename: string`  | returns true if `filename` exists, false otherwise                          |
-| `fetch()`    | `url: string`       | returns the contents of the url `url` as a string                           |
-| `fetchJson()`| `url: string`       | returns the contents of the url `url` as a JSON object                      |
+| `fetch()`    | `url: string`       | returns the contents of the url `url` as a string; gateway rules apply      |
+| `fetchJson()`| `url: string`       | returns the contents of the url `url` as a JSON object; gateway rules apply |
 | `fileContains()`| `filename: string, search: string` | returns true if `filename` contains `search`, false otherwise |
 | `getCwd()`   | --                | returns the directory stackup was run from                                  |
 | `hasEnv()`   | `name: string`      | returns true if the specified environment variable exists, otherwise false  |
@@ -561,7 +566,6 @@ Many of the fields in a `Task` can be defined using javascript. To specify an ex
 | `semver()` | `version: string` | returns a `SemVer` object based on the value of `version` |
 | `statusMessage()` | `message: string` | prints a status message to stdout, without a trailing new line |
 | `task()`     | `taskId: string`    | returns a `Task` object with the id `taskId`                                |
-| `workflow()` | --                | returns a `Workflow` object                                                 |
 | `app.FailureMessage()` | `message: string` | prints a failure message with an X to stdout with a trailing new line |
 | `app.StatusLine()` | `message: string` | prints a status message to stdout, with a trailing new line |
 | `app.StatusMessage()` | `message: string` | prints a status message to stdout, without a trailing new line |
@@ -731,18 +735,14 @@ go mod tidy
 
 ## Building the project
 
-`stackup` uses [task](https://github.com/go-task/task) for running tasks, which is a tool similar to `make`. 
+`StackUp` uses [task](https://github.com/go-task/task) for running tasks, which is a tool similar to `make`. 
 
 ```bash
 task build
 ```
 
 ---
 
-## Changelog
-
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
-
 ## Contributing
 
 Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.