{"id":14063793,"url":"https://github.com/natescherer/ChangelogManagement","last_synced_at":"2025-07-29T16:31:54.153Z","repository":{"id":43744555,"uuid":"152325608","full_name":"natescherer/ChangelogManagement","owner":"natescherer","description":"A PowerShell module for reading and manipulating changelog files in Keep a Changelog 1.0.0 format.","archived":false,"fork":false,"pushed_at":"2024-04-02T11:47:08.000Z","size":601,"stargazers_count":20,"open_issues_count":13,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-08-13T07:05:30.590Z","etag":null,"topics":["changelog","keep-a-changelog","powershell"],"latest_commit_sha":null,"homepage":"","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/natescherer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-09T21:45:36.000Z","updated_at":"2024-01-30T07:40:48.000Z","dependencies_parsed_at":"2023-01-28T03:16:01.207Z","dependency_job_id":"dfe9a31d-6cd5-4dfd-a5a3-7b96da23e7ac","html_url":"https://github.com/natescherer/ChangelogManagement","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natescherer%2FChangelogManagement","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natescherer%2FChangelogManagement/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natescherer%2FChangelogManagement/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natescherer%2FChangelogManagement/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/natescherer","download_url":"https://codeload.github.com/natescherer/ChangelogManagement/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228028621,"owners_count":17858419,"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":["changelog","keep-a-changelog","powershell"],"created_at":"2024-08-13T07:03:30.679Z","updated_at":"2024-12-04T01:31:29.369Z","avatar_url":"https://github.com/natescherer.png","language":"PowerShell","funding_links":[],"categories":["PowerShell"],"sub_categories":[],"readme":"# ChangelogManagement\n\n[![Tests Windows PowerShell](https://natescherer.github.io/ChangelogManagement/testreports/Windows_powershell/Windows_powershell_badge.svg)](https://natescherer.github.io/ChangelogManagement/testreports/Windows_powershell/Windows_powershell.html)\n[![Tests Windows Pwsh](https://natescherer.github.io/ChangelogManagement/testreports/Windows_pwsh/Windows_pwsh_badge.svg)](https://natescherer.github.io/ChangelogManagement/testreports/Windows_pwsh/Windows_pwsh.html)\n[![Tests Linux](https://natescherer.github.io/ChangelogManagement/testreports/Linux_pwsh/Linux_pwsh_badge.svg)](https://natescherer.github.io/ChangelogManagement/testreports/Linux_pwsh/Linux_pwsh.html)\n[![Tests macOS](https://natescherer.github.io/ChangelogManagement/testreports/macOS_pwsh/macOS_pwsh_badge.svg)](https://natescherer.github.io/ChangelogManagement/testreports/macOS_pwsh/macOS_pwsh.html)\n[![codecov](https://codecov.io/gh/natescherer/ChangelogManagement/branch/main/graph/badge.svg?token=rXSOfdrmo2)](https://codecov.io/gh/natescherer/ChangelogManagement)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\nChangelogManagement is a PowerShell module for reading and manipulating changelog files in [Keep a Changelog 1.0.0](https://keepachangelog.com/en/1.0.0/) format.\n\nThe primary feature is automatic updating of changelogs at release time in a CI/CD workflow via Update-Changelog.\n\nOther features include:\n\n- Creating new changelog files via New-Changelog\n- Adding data to changelog files via Add-ChangelogData\n- Getting changelog contents (parsed into a PowerShell object) via Get-ChangelogData\n- Converting changelogs into other formats via ConvertFrom-Changelog\n\n## Getting Started\n\nChangelogManagement is designed to be cross-platform and fully compatible with Windows PowerShell 5.1 and PowerShell 7+ on Windows/Linux/macOS.\n\n### Prerequisites\n\nNo prerequisites are required beyond having PowerShell installed.\n\n### Installing\n\nChangelogManagement is listed in the PowerShell Gallery [here](https://www.powershellgallery.com/packages/ChangelogManagement), which means you can install on any internet-connected computer running PowerShell 5.1+ by running this command:\n\n```PowerShell\nInstall-Module -Name ChangelogManagement\n```\n\n## Usage\n\n### Examples\n\n``` PowerShell\nLinkPattern   = @{\n    FirstRelease  = \"https://github.com/testuser/testrepo/tree/v{CUR}\"\n    NormalRelease = \"https://github.com/testuser/testrepo/compare/v{PREV}..v{CUR}\"\n    Unreleased    = \"https://github.com/testuser/testrepo/compare/v{CUR}..HEAD\"\n}\nUpdate-Changelog -ReleaseVersion 1.1.1 -LinkMode Automatic -LinkPattern $LinkPattern\n```\n\n- Does not generate output, but:\n  - Takes all Unreleased changes in .\\CHANGELOG.md and adds them to a new release tagged with ReleaseVersion and today's date.\n  - Updates links according to LinkPattern.\n  - Creates a new, blank Unreleased section.\n\n``` PowerShell\nNew-Changelog\n```\n\n- Does not generate output, but creates a new changelog at .\\CHANGELOG.md.\n\n``` PowerShell\nAdd-ChangelogData -Type \"Added\" -Data \"Spanish language translation\"\n```\n\n- Does not generate output, but adds a new Added change into changelog at  .\\CHANGELOG.md.\n\n``` PowerShell\nGet-ChangelogData\n```\n\n- Returns an object containing Header, Unreleased, Released, Footer, and LastVersion properties.\n\n``` PowerShell\nConvertFrom-Changelog -Path .\\CHANGELOG.md -Format Release -OutputPath docs\\CHANGELOG.md\n```\n\n- Does not generate output, but creates a file at docs\\CHANGELOG.md that is the same as the input with the Unreleased section removed.\n\n### Documentation\n\nFor detailed documentation, [click here on GitHub](docs), see the docs folder in a release, or run Get-Help for the individual function in PowerShell.\n\n## Questions/Comments\n\nIf you have questions, comments, etc, please enter a GitHub Issue with the \"question\" tag.\n\n## Contributing/Bug Reporting\n\nContributions and bug reports are gladly accepted! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.\n\n## Building\n\nBuilding is unnecessary, per se. The provided build YAML generates documentation files and metadata, then does the actual releasing and publishing. If modifying locally, you can simply use the updated .psd1/.psm1 files without running a build process.\n\n## Contributors\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://www.linkedin.com/in/natescherer01/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/376408?v=4?s=100\" width=\"100px;\" alt=\"Nate Scherer\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eNate Scherer\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/natescherer/ChangelogManagement/commits?author=natescherer\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/natescherer/ChangelogManagement/commits?author=natescherer\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#infra-natescherer\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/jcharlesworthuk\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/9157892?v=4?s=100\" width=\"100px;\" alt=\"James Charlesworth\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJames Charlesworth\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/natescherer/ChangelogManagement/commits?author=jcharlesworthuk\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://gaelcolas.com/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/8962101?v=4?s=100\" width=\"100px;\" alt=\"Gael\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eGael\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/natescherer/ChangelogManagement/commits?author=gaelcolas\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://se.linkedin.com/in/johanljunggren\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/7189721?v=4?s=100\" width=\"100px;\" alt=\"Johan Ljunggren\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJohan Ljunggren\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/natescherer/ChangelogManagement/commits?author=johlju\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://allcontributors.org) specification.\nContributions of any kind are welcome!\n\n## License\n\nThis project is licensed under The MIT License - see [LICENSE](LICENSE) for details.\n\n## Acknowledgements\n\n[![Hosted By: Cloudsmith](https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith\u0026style=flat-square)](https://cloudsmith.com)\n\nPackage repository hosting is graciously provided by Cloudsmith.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatescherer%2FChangelogManagement","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatescherer%2FChangelogManagement","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatescherer%2FChangelogManagement/lists"}