feat: add GithubAction for interacting with the lease service (#10)

* feat: add github action for interacting with the merge-queue

Note: this is missing test-cases, which will likely be hard to
implement. Will have a look - if all goes wrong we might be able
to add a full-loop E2E test

Signed-off-by: Matthias Riegler <[email protected]>

* chore: compile github actions

Signed-off-by: Matthias Riegler <[email protected]>

* feat: add ahead_by log

Signed-off-by: Matthias Riegler <[email protected]>

* chore: cleanup package.json

Signed-off-by: Matthias Riegler <[email protected]>

* feat: add retries

Signed-off-by: Matthias Riegler <[email protected]>

* feat: add uuid header propagation for basic authentication

Note: this needs to be addressed in the future

Signed-off-by: Matthias Riegler <[email protected]>

* chore: gen-workflows

Signed-off-by: Matthias Riegler <[email protected]>

* fix: run pre-commit

Signed-off-by: Matthias Riegler <[email protected]>

* feat: allow atomic operations

Signed-off-by: Matthias Riegler <[email protected]>

* fix: prod deploy target

Signed-off-by: Matthias Riegler <[email protected]>

* fix: pre-commit

Signed-off-by: Matthias Riegler <[email protected]>

* chore: rotate uuid for prod

Signed-off-by: Matthias Riegler <[email protected]>

---------

Signed-off-by: Matthias Riegler <[email protected]>
Signed-off-by: Matthias Riegler <[email protected]>

Author: xvzf

.gitignore

@@ -2,3 +2,4 @@ dist/
 
 kubernetes/vendor
 hack/workflows/vendor
+node_modules/

Makefile

@@ -31,8 +31,17 @@ e2e:  ## run e2e tests
 		go run github.com/onsi/ginkgo/v2/ginkgo@$(E2E_GINKGO_VERSION)
 
 .PHONY: build
-build:  ## build the application (server & cli)
+build: build-server build-gha
+
+
+.PHONY: build-server
+build-server:  ## build the application (server)
 	goreleaser build --snapshot --clean --single-target
 
+.PHONY: build-gha
+build-gha:	## build the github action JS bundle(s)
+	npm ci
+	npm run build
+
 run-server: build  ## run the server with an example config
 	 ./dist/server_${GOOS}_${GOARCH}/server -config=hack/example-server-config.yaml -log-json=false -log-debug=$(DEBUG) -port=$(LEASE_SERVICE_PORT)

README.md

@@ -185,5 +185,45 @@ sequenceDiagram
 
 
 ### GithubAction
-> :warning: WIP
-The GithubAction component of this repo interacts with the LeaseProvider and determines the priority of each run based on the commits ahead of the baseRef.
+The GithubAction component of this repo interacts with the LeaseProvider and determines the priority of each run based on the commits ahead of the base.
+It has two stages:
+1. Acquiring a lease
+2. Releasing a lease when (1) has been successful, reporting the Github action job status
+
+An example workflow can look like this:
+```yaml
+on:
+  # Trigger on PRs; here we just skip
+  pull_request:
+    branches: [ main ]
+  # Trigger on the merge group event
+  merge_group:
+    branches: [ main ]
+    types: [ checks_requested ]
+
+jobs:
+  access-shared-resource:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'merge_group' }}
+    steps:
+    - name: Checkout Plugin Repository
+      uses: actions/checkout@v3
+    - name: Aquire lease
+      id: acquire_lease
+      uses: ankorstore/gh-action-mq-lease-service@main
+      with:
+        # Endpoint to connect to
+        endpoint: https://your.lease.service.com
+        # **IMPORTANT** the job-status always has to be defined like this
+        job_status: ${{ job.status }}
+        # Optional: timeout_seconds (how long to wait before something is considered going wrong)
+        # timeout_seconds: 7200
+        # Optional: interval_seconds (the polling interval)
+        # timeout_seconds: 15
+    - name: sleep
+      # Only perform github actions when this run acquired the lease
+      if: ${{ steps.acquire_lease.outputs.result == 'acquired' }}
+      run: |
+        sleep 30
+    # Note: there is no further action required, the lease will be released in a post hook of the `Aquire lease` action.
+```