{"id":18048100,"url":"https://github.com/startautomating/helpout","last_synced_at":"2025-10-07T06:01:50.105Z","repository":{"id":36985077,"uuid":"192608060","full_name":"StartAutomating/HelpOut","owner":"StartAutomating","description":"A Helpful Toolkit for Managing PowerShell Help","archived":false,"fork":false,"pushed_at":"2024-10-13T22:51:22.000Z","size":864,"stargazers_count":35,"open_issues_count":20,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-07T15:54:00.895Z","etag":null,"topics":["markdown","powershell","powershell-help","powershell-helper"],"latest_commit_sha":null,"homepage":"https://helpout.start-automating.com","language":"PowerShell","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/StartAutomating.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["StartAutomating"]}},"created_at":"2019-06-18T20:27:10.000Z","updated_at":"2025-07-22T02:49:19.000Z","dependencies_parsed_at":"2023-01-17T12:15:46.807Z","dependency_job_id":"a44c5b23-ccbe-44db-a97d-f446d28b957a","html_url":"https://github.com/StartAutomating/HelpOut","commit_stats":{"total_commits":902,"total_committers":3,"mean_commits":300.6666666666667,"dds":"0.24611973392461195","last_synced_commit":"171343855c1579d26402dc5be6466203b916c33e"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"purl":"pkg:github/StartAutomating/HelpOut","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartAutomating%2FHelpOut","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartAutomating%2FHelpOut/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartAutomating%2FHelpOut/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartAutomating%2FHelpOut/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StartAutomating","download_url":"https://codeload.github.com/StartAutomating/HelpOut/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartAutomating%2FHelpOut/sbom","scorecard":{"id":133869,"data":{"date":"2025-08-11","repo":{"name":"github.com/StartAutomating/HelpOut","commit":"5e140153912a26a7138caf8de9780cf978520512"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.7,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/GitPub.yml:1","Warn: no topLevel permission defined: .github/workflows/TestReleaseAndPublish.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/1 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/GitPub.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/GitPub.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/GitPub.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/GitPub.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:574: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:576: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:579: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:581: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:584: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:591: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:594: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:602: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:608: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:614: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:622: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:119: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:187: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/TestReleaseAndPublish.yml:197: update your workflow using https://app.stepsecurity.io/secureworkflow/StartAutomating/HelpOut/TestReleaseAndPublish.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:2","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  11 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":-1,"reason":"internal error: internal error: Client.Checks.ListCheckRunsForRef: error during graphqlHandler.setupCheckRuns: Something went wrong while executing your query on 2025-08-12T14:18:46Z. Please include `951A:ECB19:5B6B6F:1484197:689B4D40` when reporting this issue.","details":null,"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T05:52:38.554Z","repository_id":36985077,"created_at":"2025-08-16T05:52:38.554Z","updated_at":"2025-08-16T05:52:38.554Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271430835,"owners_count":24758389,"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-21T02:00:08.990Z","response_time":74,"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":["markdown","powershell","powershell-help","powershell-helper"],"created_at":"2024-10-30T20:11:35.849Z","updated_at":"2025-10-07T06:01:49.940Z","avatar_url":"https://github.com/StartAutomating.png","language":"PowerShell","readme":"\u003cdiv align='center'\u003e\n\u003cimg src='Assets/HelpOut.svg' alt='HelpOut' /\u003e\n\u003ca href='https://www.powershellgallery.com/packages/HelpOut/'\u003e\n\u003cimg src='https://img.shields.io/powershellgallery/dt/HelpOut' /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\n## A Helpful Toolkit for Managing PowerShell Help\n\nHelpOut is a Helpful Toolkit for Managing PowerShell Help.\n\nIt helps you to:\n\n* Make Markdown Documentation and Wikis For Your Module\n* Measure how much documentation is in a script or a function\n* Find references within a script.\n\nYou can install HelpOut from the gallery, or use it as a GitHub Action.\n\n## HelpOut as a GitHub action\n\nTo use HelpOut as a GitHub action, simply copy/paste this code into a job in your workflow\n\n~~~yaml\n   - name: UseHelpOut\n     uses: StartAutomating/HelpOut@master\n~~~\n\nThen, create a `*.HelpOut.ps1` file.\n\nThis file should import your module and then use Save-MarkdownHelp with -PassThru\n\nFiles produced this way will be checked in if there are any changes.\n\n**NOTE** You must allow repository write permissions to your GitHub Workflow for HelpOut to update files.\n\n## Using HelpOut Locally\n\nTo use HelpOut locally, start off by installing it from the PowerShell Gallery:\n\n~~~PowerShell\nInstall-Module HelpOut -Scope CurrentUser -Force\n~~~\n\n### Generating MAML\n~~~PowerShell\nGet-Module HelpOut | Save-Maml # Will generate MAML files for all of the commands in HelpOut\n~~~\n\n### Generating Markdown /docs\n~~~PowerShell\nGet-Module HelpOut | Save-MarkdownHelp  # Will generate a /docs folder containing markdown help (interlinked for GitHub Pages)\n~~~\n\n### Generating Wikis\n~~~PowerShell\nGet-Module HelpOut | Save-MarkdownHelp -Wiki  # Will generate a ../HelpOut.wiki folder containing markdown help (interlinked for wikis)\n~~~\n\n\n### Using HelpOut as a GitHub Action.\n\nYou can use HelpOut as a GitHub Action.  Doing so will run whatever .HelpOut.ps1 files exist in your repository.  If a -CommitMessage is provided, or attached to any files returned by the .HelpOut.ps1, the changes will be commited.\n","funding_links":["https://github.com/sponsors/StartAutomating"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstartautomating%2Fhelpout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstartautomating%2Fhelpout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstartautomating%2Fhelpout/lists"}