{"id":19663212,"url":"https://github.com/pantheon-systems/terminus-github-actions","last_synced_at":"2025-04-28T21:32:35.621Z","repository":{"id":37582659,"uuid":"459734008","full_name":"pantheon-systems/terminus-github-actions","owner":"pantheon-systems","description":"A GitHub Action for setting up Pantheon's CLI tool, Terminus.","archived":false,"fork":false,"pushed_at":"2024-03-25T16:45:07.000Z","size":22,"stargazers_count":16,"open_issues_count":1,"forks_count":7,"subscribers_count":13,"default_branch":"main","last_synced_at":"2024-04-14T22:25:09.744Z","etag":null,"topics":["github-actions","pantheon","terminus"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pantheon-systems.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-15T20:12:21.000Z","updated_at":"2024-08-07T15:00:18.299Z","dependencies_parsed_at":"2024-06-18T23:15:32.798Z","dependency_job_id":"75abd882-c045-4391-a43a-2e2d67b83918","html_url":"https://github.com/pantheon-systems/terminus-github-actions","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantheon-systems%2Fterminus-github-actions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantheon-systems%2Fterminus-github-actions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantheon-systems%2Fterminus-github-actions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantheon-systems%2Fterminus-github-actions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pantheon-systems","download_url":"https://codeload.github.com/pantheon-systems/terminus-github-actions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224133866,"owners_count":17261302,"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","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":["github-actions","pantheon","terminus"],"created_at":"2024-11-11T16:13:43.017Z","updated_at":"2024-11-11T16:13:43.667Z","avatar_url":"https://github.com/pantheon-systems.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Actively Maintained](https://img.shields.io/badge/Pantheon-Actively_Maintained-yellow?logo=pantheon\u0026color=FFDC28)](https://pantheon.io/docs/oss-support-levels#actively-maintained-support)\n\n# Terminus GitHub Actions\n\nA GitHub Action for quickly installing and configuring the Pantheon CLI tool,\n[Terminus](https://github.com/pantheon-systems/terminus).\n\n## Usage\n\nIn order to avoid deprecation warnings, it's recommended to use the\n[`setup-php`](https://github.com/shivammathur/setup-php) action rather than rely\non the version of PHP that is installed by default on GH runners.\n\n```yaml\nsteps:\n  - name: Setup PHP\n    uses: shivammathur/setup-php@v2\n    with:\n      php-version: \"7.4\"\n\n  - name: Install Terminus\n    uses: pantheon-systems/terminus-github-actions@v1\n    with:\n      pantheon-machine-token: ${{ secrets.PANTHEON_MACHINE_TOKEN }}\n\n  - name: List sites\n    run: terminus site:list\n```\n\nBy default, this action installs the latest version of Terminus that has been\nreleased on GitHub. You can provide a specific version of Terminus to install\nusing the `terminus-version` input:\n\n```yaml\nsteps:\n  - name: Setup PHP\n    uses: shivammathur/setup-php@v2\n    with:\n      php-version: \"7.4\"\n\n  - name: Install Terminus\n    uses: pantheon-systems/terminus-github-actions@v1\n    with:\n      pantheon-machine-token: ${{ secrets.PANTHEON_MACHINE_TOKEN }}\n      terminus-version: 2.6.5\n\n  - name: List sites\n    run: terminus site:list\n```\n\nThis action will encrypt and cache the Terminus session by default to be re-used across jobs in a workflow to reduce the number of authorizations. If you need to disable this for some reason, you can set the `disable-cache` option to `true`.\n\n```yaml\nsteps:\n  - name: Install Terminus\n    uses: pantheon-systems/terminus-github-actions@v1\n    with:\n      pantheon-machine-token: ${{ secrets.PANTHEON_MACHINE_TOKEN }}\n      disable-cache: true\n```\n\nPlease note that in order to run commands that require SSH (e.g. drush or wp-cli), you will need to setup a SSH key. There are plenty of options available in the [Github Actions Marketplace](https://github.com/marketplace?type=actions\u0026query=ssh+key+). We recommend you to choose one of them and use them in your pipeline.\n\n## Diagram\n\n```mermaid\ngraph TD\n\nsubgraph Setup Terminus GitHub Action\n  A[Start] --\u003e B{inputs.terminus-version}\n  B --\u003e |Yes| C[Set TERMINUS_RELEASE to inputs.terminus-version]\n  B --\u003e |No| D[Get latest Terminus release from GitHub API]\n  D --\u003e E[Set TERMINUS_RELEASE to latest version]\n  C --\u003e F[Install Terminus]\n  E --\u003e F\n  F --\u003e G[Cache Terminus Directory]\n  G --\u003e H{inputs.pantheon-machine-token}\n  H --\u003e |Yes| I[Login to Pantheon]\n  H --\u003e |No| J[End]\n  I --\u003e J\nend\n\nstyle A fill:#f9f,stroke:#333,stroke-width:2px;\nstyle J fill:#f9f,stroke:#333,stroke-width:2px;\n\n```\n\n## Credits\n\nBig thanks to \u003ca href=\"https://github.com/G-Rath\"\u003eGareth Jones\u003c/a\u003e and \u003ca href=\"https://www.ackama.com/\"\u003eAckama\u003c/a\u003e for the initial development work.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpantheon-systems%2Fterminus-github-actions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpantheon-systems%2Fterminus-github-actions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpantheon-systems%2Fterminus-github-actions/lists"}