chore: swap makefile for justfile (#268)

# Description

<!-- Please provide a general summary of your PR changes and link any
related issues or other pull requests. -->

# Testing

<!--
Please provide details on how you tested this code. See below.

- All pull requests must be tested (unit tests where possible with
accompanying cassettes, or provide a screenshot of end-to-end testing
when unit tests are not possible)
- New features must get a new unit test
- Bug fixes/refactors must re-record existing cassettes 
-->

# Pull Request Type

Please select the option(s) that are relevant to this PR.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Improvement (fixing a typo, updating readme, renaming a variable
name, etc.)

Author: Justintime50

.github/workflows/ci.yml

@@ -10,45 +10,49 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
+      - uses: extractions/setup-just@v3
       - uses: actions/setup-go@v6
         with:
           go-version: '1.25'
         # install must occur in the same step as the linter to run properly on CI
       - name: Lint project
-        run: make install lint
+        run: just install lint
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         go-version: ['1.16', '1.17', '1.18', '1.19', '1.20', '1.21', '1.22', '1.23', '1.24', '1.25']
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
+      - uses: extractions/setup-just@v3
       - uses: actions/setup-go@v6
         with:
           go-version: ${{ matrix.go-version }}
       - name: run tests
-        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 make install test
+        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 just install test
   coverage:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
+      - uses: extractions/setup-just@v3
       - uses: actions/setup-go@v6
         with:
           go-version: '1.25'
       - name: Run coverage report
-        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 make install coverage
+        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 just install coverage
   coveralls:
     if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
+      - uses: extractions/setup-just@v3
       - uses: actions/setup-go@v6
         with:
           # NOTE: goveralls is not compatibile with go v1.22+, must remain on v1.21 max
           go-version: '1.21'
       - name: Run coverage report
-        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 make install coverage
+        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 just install coverage
       - name: Install goveralls
         run: go install github.com/mattn/goveralls@latest
       - name: Coveralls

Makefile

@@ -173,20 +173,20 @@ For additional support, see our [org-wide support policy](https://github.com/Eas
 
 ```bash
 # Install dependencies
-make install
+just install
 
 # Lint project (requires `golangci-lint` to be installed - not included)
-make lint
+just lint
 
 # Run tests
-EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test
-EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make coverage
+EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... just test
+EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... just coverage
 
 # Run security analysis on the project (requires `gosec` to be installed - not included)
-make scan
+just scan
 
 # Update submodules
-make update-examples-submodule
+just update-examples-submodule
 ```
 
 ### Testing

README.md

@@ -0,0 +1,61 @@
+# Build the project
+build:
+	go build -o ../dist/easypost-go
+
+# Clean the project
+clean:
+	rm -rf dist
+	rm $(go env GOPATH)/bin/easypost-go
+
+# Get test coverage and open it in a browser
+coverage:
+    go clean -testcache
+    go test -coverprofile=covprofile ./...
+    bash -c 'statement_cov=$(go tool cover -func=covprofile | grep total: | awk "{print substr(\$NF, 1, length(\$NF)-1)}"); if [ $(echo "$statement_cov < 78.0" | bc) -eq 1 ]; then echo "Tests passed but statement coverage failed with coverage: $statement_cov"; exit 1; fi'
+    go tool cover -html=covprofile
+
+# Initialize the examples submodule
+init-examples-submodule:
+	git submodule init
+	git submodule update
+
+# Install and vendor dependencies
+install: init-examples-submodule
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.64.6
+	curl -sSfL https://raw.githubusercontent.com/securego/gosec/master/install.sh | sh -s -- -b $(go env GOPATH)/bin
+	go mod vendor
+
+# Lint the project
+golangci:
+	$(go env GOPATH)/bin/golangci-lint run --config examples/style_guides/golang/.golangci.yml
+
+# Lint the project
+lint: golangci scan
+
+# Runs formatting tools against the project
+lint-fix:
+	$(go env GOPATH)/bin/golangci-lint run --config examples/style_guides/golang/.golangci.yml --fix
+
+# Cuts a release for the project on GitHub (requires GitHub CLI)
+# tag = The associated tag title of the release
+# target = Target branch or full commit SHA
+release tag target:
+	gh release create {{tag}} --target {{target}}
+
+# Run gosec to scan for security issues
+scan:
+	$(go env GOPATH)/bin/gosec -tests --exclude-dir=examples ./...
+
+# Test the project
+test:
+	go clean -testcache
+	go test ./... -v
+
+# Tidies up the vendor directory
+tidy:
+	go mod tidy
+
+# Update the examples submodule
+update-examples-submodule:
+	git submodule init
+	git submodule update --remote