Refactor CI and dev workflow with buildx bake (#161)

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

Author: crazy-max

.dockerignore

@@ -1,16 +1,8 @@
 /.idea
 /*.iml
 
-/.dev
-/.git
-/.github
-/.res
+.dev
 /bin
 /dist
-/docs
-/.editorconfig
-/.gitignore
-/.goreleaser.yml
-/CHANGELOG.md
-/LICENSE
-/README.md
+/site
+/coverage.txt

.github/CONTRIBUTING.md

@@ -2,18 +2,20 @@
 
 Hi there! I'm thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
 
-Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](../LICENSE).
+Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license)
+to the public under the [project's open source license](../LICENSE).
 
 ## Submitting a pull request
 
 1. [Fork](https://github.com/crazy-max/ftpgrab/fork) and clone the repository
 2. Configure and install the dependencies: `go mod download`
 3. Create a new branch: `git checkout -b my-branch-name`
-4. Make your change
-5. Test your code: `go test -covermode=atomic ./...`
-6. Build with [GoReleaser](https://goreleaser.com/): `goreleaser release --skip-publish --skip-validate --rm-dist`
-7. Push to your fork and [submit a pull request](https://github.com/crazy-max/ftpgrab/compare)
-8. Pat your self on the back and wait for your pull request to be reviewed and merged.
+4. Make your changes
+5. Validate: `docker buildx bake validate`
+6. Test your code: `docker buildx bake test`
+7. Build the project: `docker buildx bake artifact-all image-all`
+8. Push to your fork and [submit a pull request](https://github.com/crazy-max/ftpgrab/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:
 
@@ -25,5 +27,5 @@ Here are a few things you can do that will increase the likelihood of your pull
 ## Resources
 
 * [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
-* [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
-* [GitHub Help](https://help.github.com)
+* [Using Pull Requests](https://docs.github.com/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
+* [GitHub Help](https://docs.github.com)

.github/dependabot.yml

@@ -10,16 +10,6 @@ updates:
     labels:
       - ":game_die: dependencies"
       - ":robot: bot"
-  - package-ecosystem: "docker"
-    open-pull-requests-limit: 10
-    directory: "/docs"
-    schedule:
-      interval: "daily"
-      time: "08:00"
-      timezone: "Europe/Paris"
-    labels:
-      - ":game_die: dependencies"
-      - ":robot: bot"
   - package-ecosystem: "github-actions"
     open-pull-requests-limit: 10
     directory: "/"

.github/workflows/build.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - 'master'
-      - 'v*'
     tags:
       - 'v*'
     paths-ignore:
@@ -15,81 +14,48 @@ on:
   pull_request:
     branches:
       - 'master'
-      - 'v*'
     paths-ignore:
       - '**.md'
       - '.github/workflows/docs.yml'
       - 'docs/**'
       - 'mkdocs.yml'
 
+env:
+  DOCKERHUB_SLUG: crazymax/ftpgrab
+  GHCR_SLUG: ghcr.io/crazy-max/ftpgrab
+
 jobs:
-  go:
+  test:
     runs-on: ubuntu-latest
     steps:
       -
         name: Checkout
         uses: actions/checkout@v2
-      -
-        name: Prepare
-        id: prep
-        run: |
-          if [[ $GITHUB_REF == refs/tags/* ]]; then
-            echo ::set-output name=tag_name::${GITHUB_REF#refs/tags/}
-          fi
-      -
-        name: Set up Go
-        uses: actions/setup-go@v2
         with:
-          go-version: 1.15
+          fetch-depth: 0
       -
-        name: Cache Go modules
-        uses: actions/cache@v2
-        with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-
-      -
-        name: GoReleaser
-        uses: goreleaser/goreleaser-action@v2
-        with:
-          version: latest
-          args: release --skip-publish --rm-dist
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
       -
         name: Test
-        run: |
-          go test -coverprofile=coverage.txt -covermode=atomic ./...
+        uses: docker/bake-action@v1
+        with:
+          targets: test
       -
         name: Upload coverage
         uses: codecov/codecov-action@v1
-        if: success()
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.txt
-      -
-        name: GitHub Release
-        uses: softprops/action-gh-release@v1
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          draft: true
-          files: |
-            dist/checksums.txt
-            dist/*.tar.gz
-            dist/*.zip
-          name: ${{ steps.prep.outputs.tag_name }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-  docker:
+  build:
     runs-on: ubuntu-latest
-    needs: go
-    env:
-      DOCKERHUB_SLUG: crazymax/ftpgrab
-      GHCR_SLUG: ghcr.io/crazy-max/ftpgrab
+    needs: [ test ]
     steps:
       -
         name: Checkout
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       -
         name: Docker meta
         id: docker_meta
@@ -98,17 +64,19 @@ jobs:
           images: |
             ${{ env.DOCKERHUB_SLUG }}
             ${{ env.GHCR_SLUG }}
+          tag-semver: |
+            {{version}}
           tag-edge: true
-          tag-match: v(.*)
-          tag-match-group: 1
+          label-custom: |
+            org.opencontainers.image.title=FTPGrab
+            org.opencontainers.image.description=Grab your files periodically from a remote FTP or SFTP server easily
+            org.opencontainers.image.vendor=CrazyMax
       -
         name: Set up QEMU
         uses: docker/setup-qemu-action@v1
       -
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
-        with:
-          buildkitd-flags: "--debug"
       -
         name: Login to DockerHub
         if: github.event_name != 'pull_request'
@@ -125,21 +93,41 @@ jobs:
           username: ${{ secrets.GHCR_USERNAME }}
           password: ${{ secrets.GHCR_TOKEN }}
       -
-        name: Build
-        uses: docker/build-push-action@v2
+        name: Build artifacts
+        uses: docker/bake-action@v1
         with:
-          context: .
-          file: ./Dockerfile
-          platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64,linux/386,linux/ppc64le,linux/s390x
+          targets: artifact-all
+      -
+        name: Move artifacts
+        run: |
+          mv ./dist/**/* ./dist/
+      -
+        name: Upload artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: ftpgrab
+          path: ./dist/*
+          if-no-files-found: error
+      -
+        name: Build image
+        uses: docker/bake-action@v1
+        with:
+          files: |
+            ./docker-bake.hcl
+            ${{ steps.docker_meta.outputs.bake-file }}
+          targets: image-all
           push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.docker_meta.outputs.tags }}
-          build-args: |
-            VERSION=${{ steps.docker_meta.outputs.version }}
-          labels: |
-            ${{ steps.docker_meta.outputs.labels }}
-            org.opencontainers.image.title=FTPGrab
-            org.opencontainers.image.description=Grab your files periodically from a remote FTP or SFTP server easily
-            org.opencontainers.image.vendor=CrazyMax
+      -
+        name: GitHub Release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          draft: true
+          files: |
+            dist/*.tar.gz
+            dist/*.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       -
         name: Check manifest
         if: github.event_name != 'pull_request'

.github/workflows/docs.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - 'master'
-      - 'v*'
     tags:
       - 'v*'
     paths:
@@ -15,7 +14,6 @@ on:
   pull_request:
     branches:
       - 'master'
-      - 'v*'
     paths:
       - '.github/workflows/docs.yml'
       - 'docs/**'
@@ -32,35 +30,21 @@ jobs:
         with:
           fetch-depth: 0
       -
-        name: Prepare
-        id: prep
-        run: |
-          VERSION=edge
-          RELEASE=false
-          if [[ $GITHUB_REF == refs/tags/* ]]; then
-            VERSION=${GITHUB_REF#refs/tags/v}
-          fi
-          if [[ $VERSION =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
-            RELEASE=true
-          fi
-          echo ::set-output name=release::${RELEASE}
-      -
-        name: Build mkdocs Docker image
-        run: |
-          docker build -t mkdocs -f ./docs/Dockerfile ./
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
       -
         name: Build docs
-        run: |
-          docker run --rm -v "$(pwd):/docs" mkdocs build --strict
-          sudo chown -R $(id -u):$(id -g) ./site
+        uses: docker/bake-action@v1
+        with:
+          targets: docs
       -
         name: Check GitHub Pages status
         uses: crazy-max/ghaction-github-status@v2
         with:
           pages_threshold: major_outage
       -
         name: Deploy
-        if: github.event_name != 'pull_request' && (endsWith(github.ref, github.event.repository.default_branch) || steps.prepare.outputs.release == 'true')
+        if: github.event_name != 'pull_request'
         uses: crazy-max/ghaction-github-pages@v2
         with:
           target_branch: gh-pages