{"id":14980312,"url":"https://github.com/modulebuild/modulebuild","last_synced_at":"2025-10-29T00:30:31.078Z","repository":{"id":65759389,"uuid":"93702203","full_name":"ModuleBuild/ModuleBuild","owner":"ModuleBuild","description":"A scaffolding framework which can be used to kickstart a generic PowerShell module project.","archived":false,"fork":false,"pushed_at":"2020-05-02T16:40:45.000Z","size":4391,"stargazers_count":57,"open_issues_count":5,"forks_count":12,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-02-01T20:11:27.379Z","etag":null,"topics":["build","build-automation","build-script","build-system","build-tool","invoke-build","module","modulebuild","plaster","platyps","portable","powershell","powershell-gallery","powershell-module","powershell-script","readthedocs","scaffolding-framework","visual-studio"],"latest_commit_sha":null,"homepage":null,"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/ModuleBuild.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/Contributing.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-08T03:08:06.000Z","updated_at":"2024-08-05T19:43:30.000Z","dependencies_parsed_at":"2023-02-08T14:31:14.355Z","dependency_job_id":null,"html_url":"https://github.com/ModuleBuild/ModuleBuild","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModuleBuild%2FModuleBuild","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModuleBuild%2FModuleBuild/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModuleBuild%2FModuleBuild/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ModuleBuild%2FModuleBuild/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ModuleBuild","download_url":"https://codeload.github.com/ModuleBuild/ModuleBuild/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238743871,"owners_count":19523192,"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":["build","build-automation","build-script","build-system","build-tool","invoke-build","module","modulebuild","plaster","platyps","portable","powershell","powershell-gallery","powershell-module","powershell-script","readthedocs","scaffolding-framework","visual-studio"],"created_at":"2024-09-24T14:01:35.682Z","updated_at":"2025-10-29T00:30:28.653Z","avatar_url":"https://github.com/ModuleBuild.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ModuleBuild\n\nA scaffolding framework which can be used to kickstart a generic PowerShell module project with a bunch of extras.\n\n## Description\n\nA scaffolding framework which can be used to kickstart a generic PowerShell module project with an Invoke-Build backend for regular deployments and other automated tasks. This project helps make everything about starting, documenting, building, and eventually releasing your module to the PSGallary a breeze.\n\n## Requirements\n\n- PowerShell 5.0\n\n- All other module requirements will be automatically installed at build time if they are not available. (This is one of the reasons PowerShell 5 or greater is required)\n\n## Installation\n\nPowershell Gallery (PS 5.0, Preferred method)\n`install-module ModuleBuild -Scope:CurrentUser`\n\nManual Installation\n`iex (New-Object Net.WebClient).DownloadString(\"https://github.com/zloeber/ModuleBuild/raw/master/Install.ps1\")`\n\nOr clone this repository to your local machine, extract, go to the .\\releases\\ModuleBuild directory\nand import the module to your session to test, but not install this module.\n\n## Features\n\nThis build framework for PowerShell modules comes with several appealing baked in features which include;\n\n- Fully portable project directory structure and build process. So portable that you can copy it to another PowerShell 5.0 capable system and it should run the same.\n- Automatically combine your public and private functions into one clean psm1 file at build time.\n- Automatically update your psd1 file with public functions at build time.\n- Automatically scan your module release with PSScriptAnalyzer\n- Automatically upload your script to the PowerShell Gallery (with appropriate API key)\n- Automatically create project documentation folder structure and yml definition file for ReadTheDocs.org integration\n- Automatically start Pester tests during build process\n- Visual Studio Code integration (tasks)\n- Easy to manage build configuration with forward compatible design and easy to use commands\n- Includes ability to scan for sensitive terms (like your company domain name or other items that you may not want published)\n- Functions for importing public and private functions from other projects into a ModuleBuild project\n- Add new public functions to your project based on easy to create templates.\n\n## Documentation\n\nVisit the [ReadTheDocs.org documentation](http://modulebuild.readthedocs.io/en/latest/) that this module created a manifest for automatically.\n\n## Contribute\n\nPlease feel free to contribute by opening new issues or providing pull requests.\nFor the best development experience, open this project as a folder in Visual\nStudio Code and ensure that the PowerShell extension is installed.\n\n* [Visual Studio Code](https://code.visualstudio.com/)\n* [PowerShell Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell)\n\nMore contributing information can be found [here](https://github.com/zloeber/ModuleBuild/blob/master/docs/Contributing.md).\n\nThis module is tested with the PowerShell testing framework Pester. To run all tests, just start the included build script with the test param `.\\Build.ps1 -test`.\n\n## Other Information\n\n**Authors:**\n- [Zachary Loeber](https://www.the-little-things.net)\n- [Justin Perdok](https://github.com/justin-p)\n\n**Website:** https://github.com/zloeber/ModuleBuild\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodulebuild%2Fmodulebuild","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmodulebuild%2Fmodulebuild","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodulebuild%2Fmodulebuild/lists"}