Dockerised binding regeneration (#257)

Author: keynmol

.dockerignore

@@ -0,0 +1,29 @@
+# This file should be kept in sync with .gitignore
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Editor directories
+.idea/
+.vscode/
+
+# Test binary, built with `go test -c`
+*.test
+
+# CLI binary
+/scip
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+**/node_modules/
+.bin/
+**/target/
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+dist-newstyle/

.github/workflows/build-env-docker.yml

@@ -0,0 +1,69 @@
+# If this workflow stops working, first consult the documentation page where it was copied from.
+# https://docs.github.com/en/actions/publishing-packages/publishing-docker-images#publishing-images-to-github-packages
+
+name: Create and publish a Docker image for bindings build environment
+
+# Configures this workflow to run every time a change is pushed to the branch called `release`.
+on:
+  push:
+    branches: ['main']
+
+# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: sourcegraph/scip-bindings-env
+
+# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+        # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+        # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', 'main') }}
+
+        # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
+        # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
+        # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          file: dev/Dockerfile.bindings
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
+
+        # This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)."
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v1
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true

.github/workflows/protobuf-reprolang.yml

@@ -0,0 +1,37 @@
+name: Generated code is up to date
+
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/**'
+      - 'docs/**'
+      - 'bindings/**'
+      - 'scip.proto'
+      - 'buf**'
+      - '.tool-versions'
+      - 'dev/proto-generate.sh'
+      - 'dev/proto-generate-in-docker.sh'
+      - 'Dockerfile.bindings'
+      - 'cmd/scip/tests/reprolang/**'
+
+jobs:
+  gen-up-to-date:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - run: docker pull ghcr.io/sourcegraph/scip-bindings-env:latest || echo "no suitable cache"
+
+      - name: Regenerate protobuf bindings and reprolang parser
+        run: |
+          # We're changing the owner of the checkout folder to a particular user id,
+          # matching the user id of `asdf` user we create inside the docker container.
+          sudo chown -R 1001:1001 . && ./dev/generate-all-in-docker.sh
+
+      - run: git diff --exit-code

.github/workflows/protobuf.yml

@@ -1,5 +1,6 @@
 golang 1.19.10
-nodejs 16.7.0
+nodejs 16.20.2
 shellcheck 0.7.1
 yarn 1.22.17
 rust 1.71.0
+python 3.11.9

.github/workflows/reprolang.yml

@@ -27,10 +27,15 @@
 ## Code generation
 
 1. Regenerating definitions after changing the schema in [scip.proto](./scip.proto).
-   ```
-   ./dev/proto-generate.sh
-   ```
-   For the Haskell bindings, see `bindings/haskell/README.md`.
+
+   `./dev/generate-all-in-docker.sh`
+
+   We provide a script that sets up the correct build environment in Docker
+   and runs the necessary regeneration steps.
+
+   Both the proto bindings and reprolang parser are generated.
+   The only dependency you need is Docker.
+
 2. Regenerating snapshots after making changes to the CLI.
    ```
    go test ./cmd/scip -update-snapshots