Container based developer flow (#76)

Co-authored-by: CrazyMax <[email protected]>

Author: crazy-max

.dockerignore

@@ -0,0 +1,6 @@
+/.dev
+/coverage
+/dist
+/lib
+/node_modules
+/.env

.github/CONTRIBUTING.md

@@ -7,13 +7,14 @@ Contributions to this project are [released](https://help.github.com/articles/gi
 ## Submitting a pull request
 
 1. [Fork](https://github.com/crazy-max/ghaction-import-gpg/fork) and clone the repository
-2. Configure and install the dependencies: `yarn install`
-3. Make sure the tests pass on your machine: `yarn run test`
-4. Create a new branch: `git checkout -b my-branch-name`
-5. Make your change, add tests, and make sure the tests still pass
-6. Run pre-checkin: `yarn run pre-checkin`
-7. Push to your fork and [submit a pull request](https://github.com/crazy-max/ghaction-import-gpg/compare)
-8. Pat your self on the back and wait for your pull request to be reviewed and merged.
+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. Make sure the tests pass: `docker buildx bake test`
+6. Format code and build javascript artifacts: `docker buildx bake pre-checkin`
+7. Validate all code has correctly formatted and built: `docker buildx bake validate`
+8. Push to your fork and [submit a pull request](https://github.com/crazy-max/ghaction-import-gpg/compare)
+9. Pat your self on the back and wait for your pull request to be reviewed and merged.
 
 Here are a few things you can do that will increase the likelihood of your pull request being accepted:
 

.github/workflows/ci.yml

@@ -3,14 +3,13 @@ name: ci
 on:
   schedule:
     - cron: '0 10 * * *' # everyday at 10am
-  pull_request:
-    branches:
-      - master
-      - releases/v*
   push:
     branches:
-      - master
-      - releases/v*
+      - 'master'
+      - 'releases/v*'
+  pull_request:
+    branches:
+      - 'master'
 
 jobs:
   armored:

.github/workflows/pre-checkin.yml

@@ -12,6 +12,16 @@ on:
       - '**.md'
 
 jobs:
+  test-containerized:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Test
+        run: docker buildx bake test
+
   test:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -34,7 +44,6 @@ jobs:
       -
         name: Upload coverage
         uses: codecov/codecov-action@v1
-        if: success()
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage/clover.xml

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: validate
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'releases/v*'
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    branches:
+      - 'master'
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Validate
+        run: docker buildx bake validate

.github/workflows/validate.yml

@@ -35,7 +35,7 @@ pids
 lib-cov
 
 # Coverage directory used by tools like istanbul
-coverage
+/coverage
 *.lcov
 
 # nyc test coverage

.gitignore

@@ -0,0 +1,53 @@
+#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 deps AS test
+ARG GITHUB_REPOSITORY
+ENV RUNNER_TEMP=/tmp/github_runner
+ENV RUNNER_TOOL_CACHE=/tmp/github_tool_cache
+ENV GITHUB_REPOSITORY=${GITHUB_REPOSITORY}
+COPY . .
+RUN --mount=type=cache,target=/src/node_modules \
+  yarn run test
+
+FROM scratch AS test-coverage
+COPY --from=test /src/coverage /coverage/
+
+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"]