Various CI Fixes (The-OpenROAD-Project#1235)

~ Updated documentation ~ Make it so the commits created by the bot are actually created by the bot and not Jeffrey DiCorpo ~ Fix `picorv32a` design in the extended test set
MrShaTr · Jul 27, 2022 · 4f63c8c · 4f63c8c
1 parent 0b55101
commit 4f63c8c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/.github/workflow-documentation.md b/.github/workflow-documentation.md
@@ -13,6 +13,7 @@ Repository secrets are used to protect certain credentials, but also as reposito
 | Secret      | Description                                                   |
 |---------------|---------------------------------------------------------------|
 | `MAIN_BRANCH`  | The main branch for OpenLane. Format: `main`|`master`|`etc` |
+| `MY_TOKEN`  | A token for a bot account that: 1. owns the fork for the tool update. 2. has write access to the volare repo to push newly-built PDKs to. |
 
 ## CI
 
@@ -21,12 +22,12 @@ Repository secrets are used to protect certain credentials, but also as reposito
 | `DOCKER_IMAGE` | The name of the resulting Docker image (minus the tag). In our case, we use `efabless/openlane`. |
 | `TOOL_DOCKER_IMAGE` | The name of the resulting Docker images for tools (minus the tag). In our case, we use `efabless/openlane-tools`. |
 | `DOCKERHUB_USER`  | A username for a user that has push access to the organization that owns `DOCKER_IMAGE` on Docker Hub. In our case, that's an Efabless Employee with push access. |
-| `DOCKERHUB_PASSWORD`  | The password/token for the given username that has push access to the organization that owns `DOCKER_IMAGE` on Docker Hub.|
-| `LOG_UPLOAD_INFO` | **Currently unused**: Information on a cloud platform to upload buckets to, in the format `platform:bucket:encoded_credentials`, where `platform` can be `gcp`/`aws`/etc, `bucket` is the bucket name, and `encoded_credentials` are simply the relevant credentials encoded in base64. It's a bit convoluted, but it makes it so different CI users can switch the platform out by changing a single secret. Currently, only the Google Cloud Platform is supported. Support for other platforms can be added to `upload_log_tarballs.py`. If this secret is not specified, the logs will not be uploaded. |
+| `DOCKERHUB_PASSWORD`  | The password/token for the given username that has push access to the organization that owns `DOCKER_IMAGE` on Docker Hub. |
+| `VOLARE_OWNER`/`VOLARE_REPO` | (optional) A volare repo to cache builds in. In our case, `VOLARE_OWNER` would be `efabless` and `VOLARE_REPO` would be `volare`. |
 
 ## Tool Updater
 
 | Secret      | Description                                                   |
 |---------------|---------------------------------------------------------------|
 | `FORK_NAME` | A fork to push branches for tool updates to. Format `bot-account/OpenLane`  |
-| `MY_TOKEN`  | A token for the bot account that owns the fork. |
+| `BOT_AUTHOR_LINE`  | A git author line for the bot account, i.e. `Firstname Lastname <email@example.com>`. |
diff --git a/.github/workflows/tool_updater.yml b/.github/workflows/tool_updater.yml
@@ -33,6 +33,8 @@ jobs:
         with:
           token: ${{ secrets.MY_TOKEN }}
           title: "[BOT] Update ${{ env.TOOL }}"
+          author: ${{ secrets.BOT_AUTHOR_LINE }}
+          committer: ${{ secrets.BOT_AUTHOR_LINE }}
           body: |
             This is an automated PR.
 
@@ -60,6 +62,8 @@ jobs:
       - name: Create Pull Request
         if: ${{ env.NO_UPDATE != '1' }}
         uses: peter-evans/create-pull-request@v3
+        author: ${{ secrets.BOT_AUTHOR_LINE }}
+        committer: ${{ secrets.BOT_AUTHOR_LINE }}
         with:
           token: ${{ secrets.MY_TOKEN }}
           title: "[BOT] Update PDK"

diff --git a/designs/picorv32a/config.json b/designs/picorv32a/config.json
@@ -1,5 +1,5 @@
 {
-    "DESIGN_NAME": "picorv32a",
+    "DESIGN_NAME": "picorv32",
     "VERILOG_FILES": "dir::src/picorv32a.v",
     "CLOCK_PORT": "clk",
     "CLOCK_NET": "clk",