{"id":21140887,"url":"https://github.com/glotzerlab/workflows","last_synced_at":"2025-08-30T14:09:36.855Z","repository":{"id":242913532,"uuid":"810852681","full_name":"glotzerlab/workflows","owner":"glotzerlab","description":"House commonly used GitHub actions and workflows.","archived":false,"fork":false,"pushed_at":"2025-08-07T13:04:37.000Z","size":82,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":7,"default_branch":"trunk","last_synced_at":"2025-08-28T07:33:46.986Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/glotzerlab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-06-05T13:24:00.000Z","updated_at":"2025-06-05T13:21:28.000Z","dependencies_parsed_at":"2024-06-05T18:12:47.283Z","dependency_job_id":"1c2411d8-ae1b-4714-a52d-c17318ccb7b1","html_url":"https://github.com/glotzerlab/workflows","commit_stats":null,"previous_names":["glotzerlab/workflows"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/glotzerlab/workflows","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glotzerlab%2Fworkflows","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glotzerlab%2Fworkflows/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glotzerlab%2Fworkflows/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glotzerlab%2Fworkflows/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/glotzerlab","download_url":"https://codeload.github.com/glotzerlab/workflows/tar.gz/refs/heads/trunk","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glotzerlab%2Fworkflows/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272858542,"owners_count":25005092,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-30T02:00:09.474Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T07:18:41.819Z","updated_at":"2025-08-30T14:09:36.850Z","avatar_url":"https://github.com/glotzerlab.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Workflows\n\n`glotzerlab/workflows` houses reusable GitHub actions and workflows that are in common\nuse across glotzerlab software packages.\n\n## setup-uv\n\n`setup-uv` installs [uv] and *optionally* installs all the packages in a given\n`lockfile`.\n\nTo generate a lockfile, run:\n```bash\nuv pip compile --python-version 3.12 --python-platform linux requirements.in \u003e requirements.txt\n```\nand add both `requirements.in` and `requirements.txt` to the git repository.\n\nIn your action workflow, create a Python environment and then call setup-uv:\n```yaml\nsteps:\n- name: Checkout\n  uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2\n- name: Set up Python\n  uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0\n  with:\n    python-version: \"3.12\"\n- name: Set up Python environment\n  uses: glotzerlab/workflows/setup-uv@1747bc5c994ec280440dd051f2928791407692c8 # 0.5.1\n  with:\n    lockfile: \"requirements.txt\"\n```\n\n[uv]: https://github.com/astral-sh/uv\n\n## setup-mdbook\n\n`setup-mdbook` installs [mdbook].\n\nIn your action workflow:\n```yaml\nsteps:\n- name: Set up mdbook\n  uses: glotzerlab/workflows/setup-mdbook@1747bc5c994ec280440dd051f2928791407692c8 # 0.5.1\n```\n\nSee [setup-mdbook/action.yaml] for all options.\n\n[mdbook]: https://rust-lang.github.io/mdBook/\n[setup-mdbook/action.yaml]: setup-mdbook/action.yaml\n\n## setup-cargo-bundle-licenses\n\n`setup-cargo-bundle-licenses` installs [cargo-bundle-licenses].\n\nIn your action workflow:\n```yaml\nsteps:\n- name: Set up mdbook\n  uses: glotzerlab/workflows/setup-cargo-bundle-licenses@1747bc5c994ec280440dd051f2928791407692c8 # 0.5.1\n```\n\nSee [setup-cargo-bundle-licenses/action.yaml] for all options.\n\n[cargo-bundle-licenses]: https://github.com/sstadick/cargo-bundle-licenses\n[setup-cargo-bundle-licenses/action.yaml]: setup-cargo-bundle-licenses/action.yaml\n\n## setup-row\n\n`setup-row` installs [row].\n\nIn your action workflow:\n```yaml\nsteps:\n- name: Set up row\n  uses: glotzerlab/workflows/setup-row@1747bc5c994ec280440dd051f2928791407692c8 # 0.5.1\n```\n\nSee [setup-row/action.yaml] for all options.\n\n[row]: https://row.readthedocs.org\n[setup-row/action.yaml]: setup-row/action.yaml\n\n## stale\n\nTo reuse the standard stale workflow, create a workflow `stale.yaml` with the\ncontents:\n```yaml\nname: Close stale issues and PRs\n\non:\n  schedule:\n    - cron: '0 19 * * *'\n\n  workflow_dispatch:\n\njobs:\n  stale:\n    uses: glotzerlab/workflows/.github/workflows/stale.yaml@1747bc5c994ec280440dd051f2928791407692c8 # 0.5.1\n```\n\n## update-conda-lockfiles\n\nTo automatically update conda lock files monthly:\n1. Prepare a directory with the base `environment.yaml` and a script that updates all\n  lock files (see https://github.com/glotzerlab/hoomd-blue/tree/trunk-minor/.github/workflows/environments\n  for an example).\n2. Ask an organization admin to install the pull request submitter bot.\n3. Create a workflow `update-conda-lockfiles.yaml` with the contents:\n\n  ```yaml\n  name: Update conda lockfiles\n\n  on:\n    schedule:\n      - cron: '9 12 */100,1-7 3,6,2,12 4'\n\n    workflow_dispatch:\n\n  jobs:\n    update:\n      uses: glotzerlab/workflows/.github/workflows/update-conda-lockfiles.yaml@1747bc5c994ec280440dd051f2928791407692c8 # 0.5.1\n      secrets: inherit\n      with:\n        branch: \u003cname of default branch\u003e\n  ```\n\n## update-uv-lockfiles\n\nTo automatically update uv lock files monthly:\n1. Prepare a directory with the base `requirements-*.in` files and a script that updates\n   all lock files (see\n   https://github.com/glotzerlab/rowan/tree/master/.github/workflows for an example).\n2. Ask an organization admin to install the pull request submitter bot.\n3. Create a workflow `update-uv-lockfiles.yaml` with the contents:\n\n  ```yaml\n  name: Update uv lockfiles\n\n  on:\n    schedule:\n      - cron: '9 12 */100,1-7 3,6,2,12 4'\n\n    workflow_dispatch:\n\n  jobs:\n    update:\n      uses: glotzerlab/workflows/.github/workflows/update-uv-lockfiles.yaml@1747bc5c994ec280440dd051f2928791407692c8 # 0.5.1\n      secrets: inherit\n      with:\n        branch: \u003cname of default branch\u003e\n  ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglotzerlab%2Fworkflows","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglotzerlab%2Fworkflows","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglotzerlab%2Fworkflows/lists"}