From 0df7d3a3dc1da8fafcfd26d9446f79f9958b1806 Mon Sep 17 00:00:00 2001 From: Brandon McClure Date: Sun, 14 Aug 2022 14:45:45 -0600 Subject: [PATCH 1/2] docker image to build/deploy app gh action to build/push that image to ghcr --- .github/workflows/build-docker.yml | 80 ++++++++++++++++++++++++++++++ Dockerfile | 22 ++++++++ 2 files changed, 102 insertions(+) create mode 100644 .github/workflows/build-docker.yml create mode 100644 Dockerfile diff --git a/.github/workflows/build-docker.yml b/.github/workflows/build-docker.yml new file mode 100644 index 00000000..0f3f2f74 --- /dev/null +++ b/.github/workflows/build-docker.yml @@ -0,0 +1,80 @@ +name: Docker - learnGitBranching image + +on: + workflow_dispatch: + push: + branches: + - main # Trigger CI on main branch + - bmcclure/main + paths: + - '**/*' + - '.github/workflows/build-docker.yml' + pull_request: + branches: + - main # Trigger gated pipeline on PR to main + - bmcclure/main + paths: + - '**/*' + - '.github/workflows/build-docker.yml' + +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +jobs: + build-and-push-image: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Log in to the Container registry + uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract metadata (tags, labels) for Docker + id: meta + uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38 + with: + tags: | + type=ref,event=pr + type=ref,event=branch + type=sha,format=long + type=raw,value=latest + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + + - name: Build Docker image (non main branch) + uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc + if: github.ref != 'refs/heads/bmcclure/main' + with: + context: . + load: true + push: false + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + - name: Build and push Docker image (main branch) + uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc + if: github.ref == 'refs/heads/bmcclure/main' + with: + context: . + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + - id: lowercaseImageName + uses: ASzc/change-string-case-action@v2 + with: + string: ${{ env.IMAGE_NAME }} + - name: Save Docker Image archive to local filesystem + run: "docker save --output learnGitBranching.tar ${{env.REGISTRY}}/${{ steps.lowercaseImageName.outputs.lowercase }}" + - name: Upload application's Docker Image as pipeline artifact + uses: actions/upload-artifact@v2 + with: + path: learnGitBranching.tar + name: learnGitBranching.tar diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..0920851c --- /dev/null +++ b/Dockerfile @@ -0,0 +1,22 @@ +FROM node:14.20.0-alpine3.16 as build + +RUN apk add git --no-cache +WORKDIR "/src" + +COPY . /src +RUN yarn install && \ + yarn cache clean +RUN yarn gulp build + +FROM scratch AS export +WORKDIR / +COPY --from=build /src/index.html . +COPY --from=build /src/build ./build + + + +FROM nginx:stable-alpine +WORKDIR /usr/share/nginx/html/ +COPY . . +# Override the local source with the built artifacts +COPY --from=export . . From b7db714a14536cec5b6f8617816421953ff628de Mon Sep 17 00:00:00 2001 From: Brandon McClure Date: Sun, 14 Aug 2022 15:00:37 -0600 Subject: [PATCH 2/2] add makefile for local docker build Update readme with info on using docker to build/run app --- Makefile | 36 ++++++++++++++++++++++++++++++++++++ README.md | 8 ++++++++ 2 files changed, 44 insertions(+) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..0a3cad6d --- /dev/null +++ b/Makefile @@ -0,0 +1,36 @@ +ifeq ($(OS),Windows_NT) + SHELL := pwsh.exe +else + SHELL := pwsh +endif + +.SHELLFLAGS := -NoProfile -Command + +REGISTRY_NAME := ghcr.io/ +REPOSITORY_NAME := pcottle/ +IMAGE_NAME := learngitbranching +TAG := :latest + +.PHONY: all clean test +all: build + +getcommitid: + $(eval COMMITID = $(shell git log -1 --pretty=format:'%H')) + +getbranchname: + $(eval BRANCH_NAME = $(shell (git branch --show-current ) -replace '/','.')) + +build: + docker run --rm -v $${PWD}:/mnt --workdir /mnt node:14.20.0-alpine3.16 yarn install + docker run --rm -v $${PWD}:/mnt --workdir /mnt node:14.20.0-alpine3.16 yarn gulp fastBuild +build_docker: getcommitid getbranchname + docker build -t $(REGISTRY_NAME)$(REPOSITORY_NAME)$(IMAGE_NAME)$(TAG) -t $(REGISTRY_NAME)$(REPOSITORY_NAME)$(IMAGE_NAME):$(BRANCH_NAME) -t $(REGISTRY_NAME)$(REPOSITORY_NAME)$(IMAGE_NAME):$(BRANCH_NAME)_$(COMMITID) . + docker build --target export --output type=local,dest=learnGitBranching_$(BRANCH_NAME)_$(COMMITID) . + +run: + docker run -p 8080:80 $(REGISTRY_NAME)$(REPOSITORY_NAME)$(IMAGE_NAME)$(TAG) + +clean: + echo 'not implemented' +test: + echo 'not implemented' \ No newline at end of file diff --git a/README.md b/README.md index dd70ccd5..9b369809 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,14 @@ Alternatively, you can also build and run the app in a pre-configured online wor [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/pcottle/learnGitBranching/blob/main/src/js/git/index.js) +### Docker + +You can run the most recently built stable image with `docker run -p 8080:80 ghcr.io/pcottle/learngitbranching:main`. Access your environment with at [http://localhost:8080/]() + +You can build the app and image with the command: `docker build -t ghcr.io/pcottle/learngitbranching:latest`. See the [Makefile](Makefile) for information on how to build locally with docker. + + + [//]: contributor-faces