Add composite action to add vendordeps and make a PR (#143)

Author: Gold856

.github/actions/add_vendordep/action.yml

@@ -0,0 +1,53 @@
+name: "Add Vendordep"
+description: "Adds a vendordep to the repository and creates a pull request the upstream repo"
+
+inputs:
+  token:
+    description: "GitHub API token"
+    required: true
+  repo:
+    description: "Name of the repo to create branches on"
+    required: true
+  vendordep_file:
+    description: "Absolute path to the vendordep file to upload"
+    required: true
+  pr_title:
+    description: "The contents used as the PR title when opening the pull request"
+    required: true
+  pr_branch:
+    description: "The name of the branch to use when creating the pull request"
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/checkout@v4
+      with:
+        repository: wpilibsuite/vendor-json-repo
+        fetch-depth: 0 # Fetch all history so we can use git diff
+        path: vendor-json-repo
+        ref: main
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+
+    - name: Add vendordep
+      shell: bash
+      run: python add_vendordep.py --vendordep_file=${{ inputs.vendordep_file }}
+      working-directory: vendor-json-repo
+
+    - name: Debug
+      shell: bash
+      run: git --no-pager diff
+      working-directory: vendor-json-repo
+
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v6
+      with:
+        push-to-fork: ${{ inputs.repo }}
+        path: vendor-json-repo
+        base: main
+        branch: ${{ inputs.pr_branch }}
+        token: ${{ inputs.token }}
+        title: ${{ inputs.pr_title }}

BUILD.bazel

@@ -21,6 +21,11 @@ py_binary(
     ],
 )
 
+py_binary(
+    name = "add_vendordep",
+    srcs = ["add_vendordep.py"],
+)
+
 # Change this for local testing only.
 cache_directory = None
 

README.md

@@ -94,3 +94,28 @@ To create a new bundle and add it to the CI job to be checked, generated, and pu
 * In `.github/workflows/generate_bundles.yml`, add the new bundle name to the arguments for `generate_bundles.py`
 * In `.github/workflows/main.yml`, change the `YEAR` environment variable to the name of the new bundle (note: only one bundle is checked by this workflow currently)
 * Add a new test configuration to `BUILD.bazel`
+
+## Automatically creating pull requests
+If your libraries CI creates a new vendordep.json file, you can use an action contained in this repository to automatically create a pull request to add your changes. In order for the action to work, you must define a secret with write access to be able to create the pull request.
+
+Here is an example workflow:
+
+```yml
+jobs:
+  hello_world_job:
+    runs-on: ubuntu-latest
+    name: A job to say hello
+    steps:
+      - uses: actions/checkout@v4
+
+      # Steps to package your vendordep file. It is recommended that you store the new version number in a variable so that it can be used later when creating your PR's title and branch name
+
+      - name: Create Vendor JSON Repo PR
+        uses: wpilibsuite/vendor-json-repo/.github/actions/add_vendordep@latest
+        with:
+          repo: <GH account>/<vendor-json-repo fork name>
+          token: ${{ secrets.PUBLISH_VENDOR_JSON_TOKEN }}
+          vendordep_file: <path to vendordep file>
+          pr_title: "Automatically add <library name> version <version>"
+          pr_branch: "publish_<library name>_<version>"
+```

add_vendordep.py

@@ -0,0 +1,37 @@
+import json
+import argparse
+from pathlib import Path
+import shutil
+
+
+def add_vendordep(vendordep_filename):
+    vendordep_contents = json.loads(vendordep_filename.read_bytes())
+    year = vendordep_contents["frcYear"]
+
+    metadata_filename = Path(f"{year}_metadata.json")
+    metadata_contents = json.loads(metadata_filename.read_bytes())
+
+    for metadata_lib in metadata_contents:
+        if metadata_lib["uuid"] == vendordep_contents["uuid"]:
+            break
+    else:
+        raise Exception(
+            "This appears to be a new library that does not have metadata associated with it. Can not automatically update"
+        )
+
+    vendordep_destination = Path(f"{year}/{vendordep_filename.name}")
+    shutil.copy(vendordep_filename, vendordep_destination)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        "Generates one or more vendordep repository bundles for publication"
+    )
+    parser.add_argument("--vendordep_file", type=Path)
+    args = parser.parse_args()
+
+    add_vendordep(args.vendordep_file)
+
+
+if __name__ == "__main__":
+    main()