Merge pull request #2 from k7hpn/release/1.1.0

- Add upload of images based on test branch
- Add change log
- Script outputs the current version with -h

Author: k7hpn

CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.1.0] - 2021-12-02
+
+### Added
+
+- This change log
+- Push Docker images for branch "test" as well
+- Script outputs the current version with -h
+
+## [1.0.1] - 2020-12-23
+
+### Fixed
+
+- Fix bug with GHCR authentication
+
+## [1.0.0] - 2020-12-22
+
+### Added
+
+- `build.bash` build script for consistent builds across platforms
+- Sample C# .NET Core project to exercise the build script
+- `azure-pipelines-yml` to show how to call the script from Azure
+- GitHub workflow `build.yml` to show how to call the script as a GitHub Action
+
+[unreleased]: https://github.com/mcld/buildscript/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/mcld/buildscript/compare/v1.0.1...v1.1.0
+[1.0.1]: https://github.com/mcld/buildscript/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/mcld/buildscript/releases/tag/v1.0.0

README.md

@@ -4,7 +4,7 @@ The `build.bash` script helps build Docker images and upload them to container r
 
 - Run the exact same build process locally as runs in the CI environment and produces production Docker images.
 - No script modifications necessary, configure for different systems with environment variables.
-- Builds for `develop` and `main` branches produce containers tagged with the branch name and pushed to container registries.
+- Builds for `develop`, `main`, and `test` branches produce containers tagged with the branch name and pushed to container registries.
 - Branches named in the format `release/x.y.z` are pushed to container registries with that container tag as well as the container tag `latest`.
 - Other branches go through the `build` stage in the `Dockerfile` but not further (and no image is uploaded).
 - Build environment information is brought in as container labels (Git commit id, build date, version) and you can easily add more.

build.bash

@@ -38,6 +38,7 @@ Environment variables:
 - GHCR_PAT - optional - GitHub Container Registry Personal Access Token
 - GHCR_USER - optional - username to log in to the GitHub Container Registry
 
+Version 1.1.0 released 2021-12-02
 EOF
   exit
 }
@@ -126,7 +127,10 @@ if [[ -z ${BLD_BRANCH} ]]; then
   fi
 fi
 
-if [[ $BLD_BRANCH = "master" || $BLD_BRANCH = "main" || $BLD_BRANCH = "develop" ]]; then
+if [[ $BLD_BRANCH = "develop"
+      || $BLD_BRANCH = "main"
+      || $BLD_BRANCH = "master"
+      || $BLD_BRANCH = "test" ]]; then
   BLD_DOCKER_TAG=$BLD_BRANCH
   BLD_VERSION=${BLD_BRANCH}-${BLD_VERSION_DATE}
   BLD_PUSH=true
@@ -289,7 +293,7 @@ else
   --build-arg IMAGE_VERSION="$BLD_VERSION" \
   --target build .
   msg "${GREEN}===${NOFORMAT} Docker image built"
-  msg "${ORANGE}===${NOFORMAT} Not pushing Docker image: branch is not main, develop, or versioned release"
+  msg "${ORANGE}===${NOFORMAT} Not pushing Docker image: branch is not develop, main, test, or versioned release"
 fi
 
 msg "${PURPLE}===${NOFORMAT} Build script complete in $((SECONDS - BLD_STARTAT)) seconds."