Improve workflows

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/main.yml

@@ -40,3 +40,32 @@ jobs:
       - name: Run pycodestyle
         run: |
           pycodestyle src/*.py
+
+      - name: Install python yaml package
+        run: |
+          pip install pyyaml
+
+      - name: Run basic yaml validation
+        run: |
+          python tests/validate_yaml.py
+  on-fail:
+    if: failure()
+    runs-on: ubuntu-latest
+    needs: check
+    steps:
+      - name: Add label to PR
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const label = 'staging-skip';
+            const { context, github } = require('@actions/github');
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            const pull_number = context.payload.pull_request.number;
+
+            await github.issues.addLabels({
+              owner,
+              repo,
+              issue_number: pull_number,
+              labels: [label]
+            });

.gitignore

@@ -1,3 +1,6 @@
 .env
 .docker-env
 data
+*.pyc
+*.venv
+

README.md

@@ -4,14 +4,50 @@ KernelCI Pipeline
 Modular pipeline based on the new [KernelCI
 API](https://github.com/kernelci/kernelci-api).
 
-Please refer to the [pipeline design documentation](https://kernelci.org/docs/api/overview/#pipeline-design) for more details.
+Please refer to the [pipeline design documentation](https://docs.kernelci.org/api_pipeline/api/design/#pipeline-design) for more details.
 
 To use it, first, start the API.  Then start the services in this repository on the same host.
 
-Follow instructions to [add a token and start the services](https://kernelci.org/docs/api/getting-started/#setting-up-a-pipeline-instance).
+Follow instructions to [add a token and start the services](https://docs.kernelci.org/api_pipeline/api/local-instance/#setting-up-a-pipeline-instance).
 
 > **Note** The `trigger` service was run only once as it's not currently configured to run periodically.
 
+### Setting up LAVA lab
+
+For scheduling jobs, the pipeline needs to be able to submit jobs to a "LAVA lab" type of runtime and receive HTTP(S) callbacks with results over "lava-callback" service.
+Runtime is configured in yaml file following way, for example:
+```
+  lava-collabora: &lava-collabora-staging
+    lab_type: lava
+    url: https://lava.collabora.dev/
+    priority_min: 40
+    priority_max: 60
+    notify:
+      callback:
+        token: kernelci-api-token-staging
+```
+
+- url is endpoint of LAVA lab API where job will be submitted.
+- notify.callback.token is token DESCRIPTION used in LAVA job definition. This part is a little bit tricky: https://docs.lavasoftware.org/lava/user-notifications.html#notification-callbacks
+If you specify token name that does not exist in LAVA under user submitting job, callback will return token secret set to description. If following example it will be "kernelci-api-token-staging".
+If you specify token name that matches existing token in LAVA, callback will return token value (secret) from LAVA, which is usually long alphanumeric string.
+Tokens generated in LAVA in "API -> Tokens" section. Token name is "DESCRIPTION" and token value (secret) can be shown by clicking on green eye icon named "View token hash".
+Callback URL is set in pipeline instance environment variable KCI_INSTANCE_CALLBACK.
+
+The `lava-callback` service is used to receive notifications from LAVA after a job has finished.  It is configured to listen on port 8000 by default and expects in header "Authorization" token value(secret) from LAVA. Mapping of token value to lab name is done over toml file. Example:
+```
+[runtime.lava-collabora]
+runtime_token = "REPLACE-LAVA-TOKEN-GENERATED-BY-LAB-LAVA-COLLABORA"
+callback_token = "REPLACE-LAVA-TOKEN-GENERATED-BY-LAB-LAVA-COLLABORA"
+
+[runtime.lava-collabora-early-access]
+runtime_token = "REPLACE-LAVA-TOKEN-GENERATED-BY-LAB-LAVA-COLLABORA-EARLY-ACCESS"
+callback_token = "REPLACE-LAVA-TOKEN-GENERATED-BY-LAB-LAVA-COLLABORA"
+```
+In case we have single token, it will be same token used to submit job(by scheduler), runtime_token only, but if we use different to tokens to submit job and to receive callback, we need to specify both runtime_token and callback_token.
+
+Summary: Token name(description) is used in yaml configuration, token value(secret) is used in toml configuration.
+
 ### Setup KernelCI Pipeline on WSL
 
 To setup `kernelci-pipeline` on WSL (Windows Subsystem for Linux), we need to enable case sensitivity for the file system.