{"id":27203166,"url":"https://github.com/hugoalh/setup-powershell-toolkit-ghaction","last_synced_at":"2025-04-09T22:22:54.750Z","repository":{"id":152530779,"uuid":"611086264","full_name":"hugoalh/setup-powershell-toolkit-ghaction","owner":"hugoalh","description":"A GitHub Action to setup PowerShell module `hugoalh.GitHubActionsToolkit`.","archived":false,"fork":false,"pushed_at":"2025-02-02T00:10:26.000Z","size":106,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T00:16:12.622Z","etag":null,"topics":["gh-action","ghaction","github-action","powershell","setup"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hugoalh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-08T04:24:14.000Z","updated_at":"2025-01-08T04:11:35.000Z","dependencies_parsed_at":"2023-12-27T10:22:41.284Z","dependency_job_id":"be5e1304-2709-48c5-a358-ecff5d18c029","html_url":"https://github.com/hugoalh/setup-powershell-toolkit-ghaction","commit_stats":null,"previous_names":["hugoalh/setup-powershell-toolkit-ghaction","hugoalh-studio/setup-powershell-toolkit-ghaction"],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugoalh%2Fsetup-powershell-toolkit-ghaction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugoalh%2Fsetup-powershell-toolkit-ghaction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugoalh%2Fsetup-powershell-toolkit-ghaction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugoalh%2Fsetup-powershell-toolkit-ghaction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hugoalh","download_url":"https://codeload.github.com/hugoalh/setup-powershell-toolkit-ghaction/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248120718,"owners_count":21051000,"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":["gh-action","ghaction","github-action","powershell","setup"],"created_at":"2025-04-09T22:22:54.154Z","updated_at":"2025-04-09T22:22:54.737Z","avatar_url":"https://github.com/hugoalh.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Setup PowerShell Toolkit (GitHub Action)\n\n[**⚖️** MIT](./LICENSE.md)\n\n**🗂️**\n[![GitHub: hugoalh-studio/setup-powershell-toolkit-ghaction](https://img.shields.io/badge/hugoalh--studio/setup--powershell--toolkit--ghaction-181717?logo=github\u0026logoColor=ffffff\u0026style=flat \"GitHub: hugoalh-studio/setup-powershell-toolkit-ghaction\")](https://github.com/hugoalh-studio/setup-powershell-toolkit-ghaction)\n\n**🆙** ![Latest Release Version](https://img.shields.io/github/release/hugoalh-studio/setup-powershell-toolkit-ghaction?sort=semver\u0026color=2187C0\u0026label=\u0026style=flat \"Latest Release Version\") (![Latest Release Date](https://img.shields.io/github/release-date/hugoalh-studio/setup-powershell-toolkit-ghaction?color=2187C0\u0026label=\u0026style=flat \"Latest Release Date\"))\n\nA GitHub Action to setup PowerShell module `hugoalh.GitHubActionsToolkit` ([GitHub](https://github.com/hugoalh-studio/ghactions-toolkit-powershell))([PowerShell Gallery](https://www.powershellgallery.com/packages/hugoalh.GitHubActionsToolkit)).\n\n\u003e [!IMPORTANT]\n\u003e This documentation is v2.0.0 based; To view other version's documentation, please visit the [versions list](https://github.com/hugoalh-studio/setup-powershell-toolkit-ghaction/tags) and select the correct version.\n\n## 🎯 Target\n\n- GitHub Actions Runner\n  \u003e **🛡️ Require Permission**\n  \u003e\n  \u003e *N/A*\n\n  \u003e **💽 Require Software**\n  \u003e\n  \u003e - PowerShell \u003e= v7.2.0\n\n## 🔰 Usage\n\n### Composite Action\n\n1. Import at the metadata (`action.yml`):\n    ```yml\n    runs:\n      using: \"composite\"\n      steps:\n        - uses: \"hugoalh-studio/setup-powershell-toolkit-ghaction@\u003cTag\u003e\"\n    ```\n\n### Workflow\n\n1. Import at the workflow (`.github/workflows/\u003cWorkflowName\u003e.yml`):\n    ```yml\n    jobs:\n      job_id:\n        runs-on: \"________\" # Any\n        steps:\n          - uses: \"hugoalh-studio/setup-powershell-toolkit-ghaction@\u003cTag\u003e\"\n    ```\n\n## 🧩 Input\n\n\u003e [!NOTE]\n\u003e All of the inputs are optional; Use this action without any input will default to install major equitant latest version of `2.1.0` for current user, and keep the setting that modified.\n\n### `sudo`\n\n`\u003cBoolean = False\u003e` Whether to execute in sudo mode on non-Windows environment. This must set to `True` in order to able install for all users on non-Windows environment (i.e.: when [input `scope`](#scope) is `\"AllUsers\"`).\n\n### `version`\n\n`\u003cString = \"^2.1.0\"\u003e` Target version, by [Semantic Versioning (SemVer) 2.0.0](https://semver.org/spec/v2.0.0.html) with optional modifier; Default to major equitant latest version of `2.1.0`.\n\n- **`\"Latest\"`:** Latest version\n- **`\"\u003c1.2.3\"`:** Less than this version\n- **`\"\u003c=1.2.3\"`:** Less than or equal to this version\n- **`\"1.2.3\"` / `\"=1.2.3\"`:** Equal to this version\n- **`\"\u003e=1.2.3\"`:** Greater than or equal to this version\n- **`\"\u003e1.2.3\"`:** Greater than this version\n- **`\"^1.2.3\"`:** Between this version and major equitant latest version\n- **`\"~1.2.3\"`:** Between this version and minor equitant latest version\n\n### `allowprerelease`\n\n`\u003cBoolean = False\u003e` Whether to allow target pre release version.\n\n### `scope`\n\n`\u003cString = \"CurrentUser\"\u003e` Installation scope.\n\n- **`\"AllUsers\"`:** For all users. Also need to set [input `sudo`](#sudo) to `True` on non-Windows environment.\n- **`\"CurrentUser\"`:** For current user.\n\n### `force`\n\n`\u003cBoolean = False\u003e` Whether to force install or reinstall target (pre release) version.\n\n### `keepsetting`\n\n`\u003cBoolean = False\u003e` Whether to keep the setting that modified.\n\n## 🧩 Output\n\n### `path`\n\n`\u003cString\u003e` Path of the installation.\n\n### `version`\n\n`\u003cSemVer\u003e` Version of the installation.\n\n## ✍️ Example\n\n- ```yml\n  jobs:\n    job_id:\n      name: \"Hello World\"\n      runs-on: \"ubuntu-latest\"\n      steps:\n        - name: \"Setup PowerShell Toolkit\"\n          uses: \"hugoalh-studio/setup-powershell-toolkit-ghaction@v2.0.0\"\n        - run: |\n            Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Scope 'Local'\n            Write-GitHubActionsNotice -Message 'Hello, world!'\n          shell: \"pwsh\"\n  ```\n\n## 📚 Guide\n\n- GitHub Actions\n  - [Enabling debug logging](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugoalh%2Fsetup-powershell-toolkit-ghaction","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhugoalh%2Fsetup-powershell-toolkit-ghaction","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugoalh%2Fsetup-powershell-toolkit-ghaction/lists"}