From a3ad02f0ed15821a28d33aba34b0dfee4b689acc Mon Sep 17 00:00:00 2001 From: "Yousif H. Akbar" <11247449+yhakbar@users.noreply.github.com> Date: Sun, 20 Dec 2020 10:39:09 -0500 Subject: [PATCH 1/4] Switching from master to main. Also, addressing .md best practices --- docs/development.md | 10 +++++----- docs/docker.md | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/development.md b/docs/development.md index 33c0694..0e073bd 100644 --- a/docs/development.md +++ b/docs/development.md @@ -2,19 +2,19 @@ * Run the test script: -``` +```bash ./scripts/test.sh ``` -# How to release +## How to release -From the `master` branch, run the release script: +From the `main` branch, run the release script: -``` +```bash ./scripts/release.sh ``` -Then, create a pull request with your version bump and get it merged to `master`. +Then, create a pull request with your version bump and get it merged to `main`. The release script will: diff --git a/docs/docker.md b/docs/docker.md index ba791a7..72d8adc 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -6,35 +6,35 @@ this package up and running through Docker. ## Build Docker image ```bash -$ docker build -t gorson . +docker build -t gorson . ``` or ```bash -$ docker-compose build +docker-compose build ``` ## Run tests on Docker image ```bash -$ docker run -it -v `pwd`:/app gorson ./scripts/test.sh +docker run -it -v "$PWD":/app gorson ./scripts/test.sh ``` or ```bash -$ docker-compose run --rm builder ./scripts/test.sh +docker-compose run --rm builder ./scripts/test.sh ``` ## Create releases ```bash -$ docker run -it -v `pwd`:/app gorson ./scripts/docker-release.sh +docker run -it -v "$PWD":/app gorson ./scripts/docker-release.sh ``` or ```bash -$ docker-compose run --rm builder ./scripts/docker-release.sh +docker-compose run --rm builder ./scripts/docker-release.sh ``` From 50fb29815e04a427bdb5f440e035a995db30d60f Mon Sep 17 00:00:00 2001 From: "Yousif H. Akbar" <11247449+yhakbar@users.noreply.github.com> Date: Sun, 20 Dec 2020 10:39:43 -0500 Subject: [PATCH 2/4] Fixing what shellcheck tells me to fix --- scripts/build-release.sh | 6 +++--- scripts/docker-release.sh | 4 ++-- scripts/lint.sh | 8 +++----- scripts/release.sh | 4 ++-- 4 files changed, 10 insertions(+), 12 deletions(-) diff --git a/scripts/build-release.sh b/scripts/build-release.sh index d375bc7..eac1f1a 100755 --- a/scripts/build-release.sh +++ b/scripts/build-release.sh @@ -10,7 +10,7 @@ cd "$( dirname "${BASH_SOURCE[0]}" )/.." ./scripts/clean.sh mkdir -p bin -VERSION=`egrep -o '[0-9]' ./internal/gorson/version/version.go` +VERSION=$(grep -E -o '[0-9]' ./internal/gorson/version/version.go) >&2 echo "building gorson_builder docker image" # build a local docker image called gorson_builder: we'll use this to @@ -32,10 +32,10 @@ for platform in darwin linux; do \ # import C packages (we don't do this, so we set it to 0 to turn CGO off) # see https://golang.org/cmd/cgo/ docker run --rm \ - -v ${PWD}:/app \ + -v "${PWD}":/app \ -e "GOOS=$platform" \ -e "GOARCH=amd64" \ -e "CGO_ENABLED=0" \ gorson_builder \ - go build -o bin/$binary_name + go build -o "bin/$binary_name" done diff --git a/scripts/docker-release.sh b/scripts/docker-release.sh index 94460dd..e3b69b7 100755 --- a/scripts/docker-release.sh +++ b/scripts/docker-release.sh @@ -10,7 +10,7 @@ cd "$( dirname "${BASH_SOURCE[0]}" )/.." ./scripts/clean.sh mkdir -p bin -VERSION=`egrep -o '[0-9]+\.[0-9a-z.\-]+' ./internal/gorson/version/version.go` +VERSION=$(grep -E -o '[0-9]+\.[0-9a-z.\-]+' ./internal/gorson/version/version.go) # We want to make sure the final builds are formatted and linted properly. ./scripts/format.sh @@ -30,5 +30,5 @@ for platform in darwin linux; do \ # * CGO_ENABLED controls whether the go compiler allows us to # import C packages (we don't do this, so we set it to 0 to turn CGO off) # see https://golang.org/cmd/cgo/ - GOOS=$platform GOARCH=amd64 CGO_ENABLED=0 go build -o bin/$binary_name + GOOS=$platform GOARCH=amd64 CGO_ENABLED=0 go build -o "bin/$binary_name" done diff --git a/scripts/lint.sh b/scripts/lint.sh index e8b8810..98dbaae 100755 --- a/scripts/lint.sh +++ b/scripts/lint.sh @@ -8,11 +8,9 @@ IFS=$'\n\t' >&2 echo 'linting' -invalid="$(gofmt -s -l . | grep -v vendor)" -test -z "$invalid" -if [[ $? -ne 0 ]]; then +if invalid="$(gofmt -s -l . | grep -v vendor)"; then >&2 echo "linting failed on the following files; ./scripts/format.sh should fix this" - >&2 echo $invalid + >&2 echo "$invalid" exit 1 fi -echo 'linting succeeded :)' \ No newline at end of file +echo 'linting succeeded :)' diff --git a/scripts/release.sh b/scripts/release.sh index d93943a..daeb5f6 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -4,8 +4,8 @@ IFS=$'\n\t' cd "$( dirname "${BASH_SOURCE[0]}" )/.." -CURRENT=$(egrep -o '[0-9]' ./internal/gorson/version/version.go) -NEW=`expr $CURRENT + 1` +CURRENT=$(grep -E -o '[0-9]' ./internal/gorson/version/version.go) +NEW=$(( CURRENT + 1)) sed "-i" "" "-e" "s/-$CURRENT-/-$NEW-/g" README.md sed "-i" "" "-e" "s/\/$CURRENT\//\/$NEW\//g" README.md From f3fa1e07e532323cdb99c71b51724311cfada270 Mon Sep 17 00:00:00 2001 From: "Yousif H. Akbar" <11247449+yhakbar@users.noreply.github.com> Date: Sun, 20 Dec 2020 10:40:01 -0500 Subject: [PATCH 3/4] Too many whitespaces at the end here --- .github/workflows/release.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a022458..112267b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -42,4 +42,3 @@ jobs: data: await fs.readFile(`./bin/${file}`) }); } - From bd9acff709372723528439c9079662b3426deaa9 Mon Sep 17 00:00:00 2001 From: "Yousif H. Akbar" <11247449+yhakbar@users.noreply.github.com> Date: Sun, 20 Dec 2020 10:40:22 -0500 Subject: [PATCH 4/4] No need for circle CI now that we are using GHA --- .circleci/config.yml | 17 ----------------- 1 file changed, 17 deletions(-) delete mode 100644 .circleci/config.yml diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index 79e4c6a..0000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,17 +0,0 @@ -# Golang CircleCI 2.0 configuration file -# -# Check https://circleci.com/docs/2.0/language-go/ for more details -version: 2 -jobs: - build: - docker: - # specify the version - - image: circleci/golang:1.13 - - steps: - - checkout - - # specify any bash command here prefixed with `run: ` - - run: ./scripts/build.sh - - run: ./scripts/test.sh - - run: ./scripts/lint.sh