From 00f6e60ec408135f86bddc48dc873db8d2d464f7 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Mon, 15 Mar 2021 23:27:45 +0100 Subject: [PATCH] Container based developer flow --- .dockerignore | 4 +++ .github/CONTRIBUTING.md | 9 +++--- .github/workflows/ci.yml | 4 +-- .github/workflows/pre-checkin.yml | 30 ------------------ .github/workflows/validate.yml | 25 +++++++++++++++ Dockerfile.dev | 41 ++++++++++++++++++++++++ docker-bake.hcl | 52 +++++++++++++++++++++++++++++++ 7 files changed, 129 insertions(+), 36 deletions(-) create mode 100644 .dockerignore delete mode 100644 .github/workflows/pre-checkin.yml create mode 100644 .github/workflows/validate.yml create mode 100644 Dockerfile.dev create mode 100644 docker-bake.hcl diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000000..00a9f5494e1 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,4 @@ +/.dev +/dist +/lib +/node_modules diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9355db3761e..d5a1c752f03 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -7,10 +7,11 @@ Contributions to this project are [released](https://help.github.com/articles/gi ## Submitting a pull request 1. [Fork](https://github.com/crazy-max/ghaction-github-pages/fork) and clone the repository -2. Configure and install the dependencies: `yarn install` -4. Create a new branch: `git checkout -b my-branch-name` -5. Make your change -6. Run pre-checkin: `yarn run pre-checkin` +2. Configure and install the dependencies locally: `yarn install` +3. Create a new branch: `git checkout -b my-branch-name` +4. Make your changes +5. Format code and build javascript artifacts: `docker buildx bake pre-checkin` +6. Validate all code has correctly formatted and built: `docker buildx bake validate` 7. Push to your fork and [submit a pull request](https://github.com/crazy-max/ghaction-github-pages/compare) 8. Pat your self on the back and wait for your pull request to be reviewed and merged. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 470f72a9574..f2242f271c8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,8 +5,8 @@ on: - cron: '0 10 * * *' # everyday at 10am push: branches: - - dev - - releases/v* + - 'dev' + - 'releases/v*' jobs: ci: diff --git a/.github/workflows/pre-checkin.yml b/.github/workflows/pre-checkin.yml deleted file mode 100644 index 38808c1f016..00000000000 --- a/.github/workflows/pre-checkin.yml +++ /dev/null @@ -1,30 +0,0 @@ -name: pre-checkin - -on: - push: - paths-ignore: - - '**.md' - pull_request: - paths-ignore: - - '**.md' - -jobs: - pre-checkin: - runs-on: ubuntu-latest - steps: - - - name: Checkout - uses: actions/checkout@v2 - - - name: Install - run: yarn install - - - name: Pre-checkin - run: yarn run pre-checkin - - - name: Check for uncommitted changes - run: | - if [[ `git status --porcelain` ]]; then - git status --porcelain - echo "::warning::Found changes. Please run 'yarn run pre-checkin' and push" - fi diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml new file mode 100644 index 00000000000..47b6d21cf8b --- /dev/null +++ b/.github/workflows/validate.yml @@ -0,0 +1,25 @@ +name: validate + +on: + push: + branches: + - 'dev' + - 'releases/v*' + paths-ignore: + - '**.md' + pull_request: + branches: + - 'dev' + paths-ignore: + - '**.md' + +jobs: + validate: + runs-on: ubuntu-latest + steps: + - + name: Checkout + uses: actions/checkout@v2 + - + name: Validate + run: docker buildx bake validate diff --git a/Dockerfile.dev b/Dockerfile.dev new file mode 100644 index 00000000000..c6e16ae1ab8 --- /dev/null +++ b/Dockerfile.dev @@ -0,0 +1,41 @@ +#syntax=docker/dockerfile:1.2 + +FROM node:12 AS deps +WORKDIR /src +COPY package.json yarn.lock ./ +RUN --mount=type=cache,target=/src/node_modules \ + yarn install + +FROM scratch AS update-yarn +COPY --from=deps /src/yarn.lock / + +FROM deps AS validate-yarn +COPY .git .git +RUN status=$(git status --porcelain -- yarn.lock); if [ -n "$status" ]; then echo $status; exit 1; fi + +FROM deps AS base +COPY . . + +FROM base AS build +RUN --mount=type=cache,target=/src/node_modules \ + yarn build + +FROM base AS run-format +RUN --mount=type=cache,target=/src/node_modules \ + yarn run format + +FROM scratch AS format +COPY --from=run-format /src/src/*.ts /src/ + +FROM base AS validate-format +RUN --mount=type=cache,target=/src/node_modules \ + yarn run format-check + +FROM scratch AS dist +COPY --from=build /src/dist/ /dist/ + +FROM build AS validate-build +RUN status=$(git status --porcelain -- dist); if [ -n "$status" ]; then echo $status; exit 1; fi + +FROM base AS dev +ENTRYPOINT ["bash"] diff --git a/docker-bake.hcl b/docker-bake.hcl new file mode 100644 index 00000000000..137bf098639 --- /dev/null +++ b/docker-bake.hcl @@ -0,0 +1,52 @@ +variable "GITHUB_REPOSITORY" { + default = "crazy-max/ghaction-github-pages" +} + +group "default" { + targets = ["build"] +} + +group "pre-checkin" { + targets = ["update-yarn", "format", "build"] +} + +group "validate" { + targets = ["validate-format", "validate-build", "validate-yarn"] +} + +target "dockerfile" { + dockerfile = "Dockerfile.dev" +} + +target "update-yarn" { + inherits = ["dockerfile"] + target = "update-yarn" + output = ["."] +} + +target "build" { + inherits = ["dockerfile"] + target = "dist" + output = ["."] +} + +target "format" { + inherits = ["dockerfile"] + target = "format" + output = ["."] +} + +target "validate-format" { + inherits = ["dockerfile"] + target = "validate-format" +} + +target "validate-build" { + inherits = ["dockerfile"] + target = "validate-build" +} + +target "validate-yarn" { + inherits = ["dockerfile"] + target = "validate-yarn" +}