https://github.com/the-openroad-project/actions
https://github.com/the-openroad-project/actions
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/the-openroad-project/actions
- Owner: The-OpenROAD-Project
- License: apache-2.0
- Created: 2021-04-23T18:11:31.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T14:21:16.000Z (over 1 year ago)
- Last Synced: 2025-10-13T04:46:00.866Z (8 months ago)
- Language: Python
- Size: 54.7 KB
- Stars: 1
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: security_scan_on_push/action.yml
Awesome Lists containing this project
README
# OpenROAD GitHub Actions
This repository contains GitHub Actions for usage with the OpenROAD project's
repositories.
## [`security_scan_on_push`](./security_scan_on_push)
This action prevents accidental publishing of private data such as confidential
PDK information.
## [`clone_from`](./clone_from)
This action clones a GitHub repository using https and the GitHub token.
It uses "tree less" clone so that it can be pushed from while not needing the
complete repository contents.
## [`push_to`](./push_to)
This action pushes to a GitHub repository using ssh with
[a deploy key (with write access)](https://docs.github.com/en/developers/overview/managing-deploy-keys#deploy-keys).
Steps for using are;
1) Generate a new deploy key using the command `ssh-keygen -t ed25519 -f deploy_key`.
2) Add the private key output (in file `deploy_key`) to the repositories
[GitHub Actions secrets](https://docs.github.com/en/developers/overview/managing-deploy-keys#deploy-keys).
3) Add the public key output (in file `deploy_key.pub`) to the repositories
Deploy Keys making sure to give the key write access.
4) Add the GitHub Action in your workflow.yml like so;
```yaml
- name: Push to staging repository.
uses: The-OpenROAD-Project/actions/push_to@main
with:
owner: The-OpenROAD-Project
repo: OpenROAD
branch: main
deployKey: ${{ secrets.STAGING_DEPLOY_KEY }}
```
## [`delete_from`](./delete_from)
This action deletes a branch from a GitHub repository using ssh with
[a deploy key (with write access)](https://docs.github.com/en/developers/overview/managing-deploy-keys#deploy-keys).
Follow the setups in `push_to` action to set up a deploy key.
## [`remove_label`](./remove_label)
Removes a label from a pull request.
## [`send_pr`](./send_pr)
After a branch has been pushed to the staging repository, automatically create
a pull request from the staging repository to the upstream repository.
## [`link_pr`](./link_pr)
After a pull request has been created from the staging repository to the
upstream repository, this GitHub Actions creates a deployment linking to the
public pull request.
## [`upstream_sync`](./upstream_sync)
Pulls the upstream repository into the local repository.
## [`openlane_run`](./openlane_run)
The goal of this action is to run a given design through the OpenLane flow
using a given tag. Optionally a PR can be created to update a stable tag
file stored in the repository.
Arguments:
- `ol_tag` [optional, default: `master`]: OpenLane tag. You can set to
`ol_tag_file` to use the value from the file content.
- `update_tag` [optional, default: `false`]: if the test is successful
update stable tag pointed by the `ol_tag_file` input.
- `ol_tag_file` [optional, default: `.github/openlane-stable-tag`]: File
where to store stable OpenLane tag. The file must exists before running
with this feature.
- `tools_list` [optional, default: `''`]: List of tools to update to the
latest version. Multiple values are separated by a space, e.g.,
"openroad_app magic".