way_of_working-changelog-keepachangelog 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76adcd5458f1dc834c84f60a7a373f7e4c8d3ef278fb0e52aeba5608d92ce10a
+  data.tar.gz: d8f0a5ebb3bbe32adcb8004fce8194d60f255a739ef53909e3ee5b4fd6733acd
+SHA512:
+  metadata.gz: b8a4dde18d8fadfa90abe34b999d32ceda2be94ddae5f6afd97e320a800f8b276236b9d2351d0d210e67223cddeee9fdb568b9af08151b76c028612b20d57e41
+  data.tar.gz: e3901b676eadd19ae5d8232faeebbd76f0fc1d764a9f44a276d116c7410f9274b06e147682e3774fc8fc9ee564d6decd7f1bec722d24a8c382bed21ce95c7adc

data/.alexrc

@@ -0,0 +1,3 @@
+{
+  "profanitySureness": 1
+}

data/.mega-linter.yml

@@ -0,0 +1,145 @@
+---
+# Configuration file for MegaLinter
+# See all available variables at https://megalinter.io/configuration/
+# and in linters documentation
+
+APPLY_FIXES: none  # all, none, or list of linter keys
+ENABLE_LINTERS:  # All other linters will be disabled by default
+  ### Languages
+  - BASH_EXEC  # in Super-Linter
+  - BASH_SHELLCHECK  # in Super-Linter
+  - BASH_SHFMT  # in Super-Linter
+  - C_CLANG_FORMAT
+  - C_CPPLINT
+  # - CLOJURE_CLJ_KONDO  # in Super-Linter
+  # - CLOJURE_CLJSTYLE
+  - COFFEE_COFFEELINT  # in Super-Linter
+  - CPP_CLANG_FORMAT
+  - CPP_CPPLINT  # in Super-Linter
+  - CSHARP_CSHARPIER
+  - CSHARP_DOTNET_FORMAT  # in Super-Linter
+  - CSHARP_ROSLYNATOR
+  - DART_DARTANALYZER  # in Super-Linter
+  - GO_GOLANGCI_LINT  # in Super-Linter
+  - GO_REVIVE
+  # - GROOVY_NPM_GROOVY_LINT  # in Super-Linter
+  - JAVA_CHECKSTYLE  # in Super-Linter
+  - JAVA_PMD
+  - JAVASCRIPT_ES  # in Super-Linter
+  # - JAVASCRIPT_PRETTIER
+  - JAVASCRIPT_STANDARD  # in Super-Linter
+  - JSX_ESLINT
+  - KOTLIN_DETEKT
+  - KOTLIN_KTLINT  # in Super-Linter
+  # - LUA_LUACHECK  # in Super-Linter
+  # - LUA_SELENE
+  # - LUA_STYLUA
+  - MAKEFILE_CHECKMAKE
+  # - PERL_PERLCRITIC  # in Super-Linter
+  # - PHP_BUILTIN
+  # - PHP_PHPCS  # in Super-Linter
+  # - PHP_PHPCSFIXER
+  # - PHP_PHPLINT  # in Super-Linter
+  # - PHP_PHPSTAN  # in Super-Linter
+  # - PHP_PSALM  # in Super-Linter
+  # - POWERSHELL_POWERSHELL
+  # - POWERSHELL_POWERSHELL_FORMATTER
+  - PYTHON_BANDIT
+  - PYTHON_BLACK  # in Super-Linter
+  - PYTHON_FLAKE8  # in Super-Linter
+  - PYTHON_ISORT  # in Super-Linter
+  - PYTHON_MYPY
+  - PYTHON_PYLINT  # in Super-Linter
+  - PYTHON_PYRIGHT
+  - PYTHON_RUFF
+  - R_LINTR  # in Super-Linter
+  # - RAKU_RAKU  # in Super-Linter
+  # - RUBY_RUBOCOP  # in Super-Linter
+  - RUST_CLIPPY  # in Super-Linter
+  # - SALESFORCE_LIGHTNING_FLOW_SCANNER
+  # - SALESFORCE_SFDX_SCANNER_APEX
+  # - SALESFORCE_SFDX_SCANNER_AURA
+  # - SALESFORCE_SFDX_SCANNER_LWC
+  - SCALA_SCALAFIX
+  - SQL_SQLFLUFF  # in Super-Linter
+  - SQL_TSQLLINT
+  - SWIFT_SWIFTLINT
+  - TSX_ESLINT
+  - TYPESCRIPT_ES  # in Super-Linter
+  # - TYPESCRIPT_PRETTIER
+  - TYPESCRIPT_STANDARD  # in Super-Linter
+  # - VBDOTNET_DOTNET_FORMAT
+
+  ### Formats
+  - CSS_STYLELINT  # in Super-Linter
+  - ENV_DOTENV_LINTER  # in Super-Linter
+  # - GRAPHQL_GRAPHQL_SCHEMA_LINTER
+  # - HTML_DJLINT # Refuses to see config file
+  - HTML_HTMLHINT  # in Super-Linter
+  - JSON_ESLINT_PLUGIN_JSONC  # in Super-Linter
+  - JSON_JSONLINT
+  - JSON_NPM_PACKAGE_JSON_LINT
+  # - JSON_PRETTIER
+  - JSON_V8R
+  # - LATEX_CHKTEX  # in Super-Linter
+  - MARKDOWN_MARKDOWNLINT  # in Super-Linter
+  - MARKDOWN_MARKDOWN_LINK_CHECK
+  - MARKDOWN_MARKDOWN_TABLE_FORMATTER
+  - MARKDOWN_REMARK_LINT
+  # - PROTOBUF_PROTOLINT  # in Super-Linter
+  # - RST_RSTCHECK
+  # - RST_RSTFMT
+  # - RST_RST_LINT
+  - XML_XMLLINT  # in Super-Linter
+  # - YAML_PRETTIER
+  - YAML_V8R
+  - YAML_YAMLLINT  # in Super-Linter
+
+  ### Tooling
+  - ACTION_ACTIONLINT  # in Super-Linter
+  - ANSIBLE_ANSIBLE_LINT  # in Super-Linter
+  - API_SPECTRAL
+  - ARM_ARM_TTK  # in Super-Linter
+  # - BICEP_BICEP_LINTER
+  - CLOUDFORMATION_CFN_LINT  # in Super-Linter
+  - DOCKERFILE_HADOLINT  # in Super-Linter
+  - EDITORCONFIG_EDITORCONFIG_CHECKER  # in Super-Linter
+  # - GHERKIN_GHERKIN_LINT  # in Super-Linter
+  - KUBERNETES_HELM
+  - KUBERNETES_KUBECONFORM
+  - KUBERNETES_KUBESCAPE
+  - PUPPET_PUPPET_LINT
+  # - SNAKEMAKE_LINT  # in Super-Linter
+  # - SNAKEMAKE_SNAKEFMT  # in Super-Linter
+  # - TEKTON_TEKTON_LINT  # in Super-Linter
+  - TERRAFORM_TERRAFORM_FMT  # in Super-Linter
+  - TERRAFORM_TERRAGRUNT  # in Super-Linter
+  - TERRAFORM_TERRASCAN  # in Super-Linter
+  - TERRAFORM_TFLINT  # in Super-Linter
+
+  ### Code quality checkers
+  - COPYPASTE_JSCPD  # in Super-Linter
+  - REPOSITORY_CHECKOV
+  - REPOSITORY_DEVSKIM
+  - REPOSITORY_DUSTILOCK
+  - REPOSITORY_GIT_DIFF
+  - REPOSITORY_GITLEAKS  # in Super-Linter
+  - REPOSITORY_GRYPE
+  - REPOSITORY_KICS
+  - REPOSITORY_LS_LINT
+  - REPOSITORY_SECRETLINT
+  - REPOSITORY_SEMGREP
+  - REPOSITORY_SYFT
+  - REPOSITORY_TRIVY
+  - REPOSITORY_TRIVY_SBOM
+  - REPOSITORY_TRUFFLEHOG
+  # - SPELL_CSPELL
+  - SPELL_LYCHEE
+  - SPELL_PROSELINT
+  - SPELL_VALE
+
+SHOW_ELAPSED_TIME: false
+FILEIO_REPORTER: false
+FAIL_IF_MISSING_LINTER_IN_FLAVOR: true
+# DISABLE_ERRORS: true # Uncomment if you want MegaLinter to detect
+# errors but not block CI to pass

data/.rubocop

@@ -0,0 +1 @@
+--config .github/linters/rubocop_defaults.yml

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2025-10-24
+
+### Added
+
+- Initial release of init command and GitHub audit rule
+
+[unreleased]: https://github.com/HealthDataInsight/way_of_working-changelog-keepachangelog/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/HealthDataInsight/way_of_working-changelog-keepachangelog/releases/tag/v1.0.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Health Data Insight CIC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# WayOfWorking::Changelog::Keepachangelog
+
+<!-- Way of Working: Main Badge Holder Start -->
+![Way of Working Badge](https://img.shields.io/badge/Way_of_Working-v2.0.1-%238169e3?labelColor=black)
+<!-- Way of Working: Additional Badge Holder Start -->
+<!-- Way of Working: Badge Holder End -->
+
+This is a plugin for the [Way of Working](https://github.com/HealthDataInsight/way_of_working) framework. It uses [keep a changelog](https://keepachangelog.com/en/1.1.0/) version 1.1.0. It has a well-defined structure that makes it an accessible format for people and tooling.
+
+To quote from their website:
+
+> Guiding Principles:
+> * Changelogs are for humans, not machines.
+> * There should be an entry for every single version.
+> * The same types of changes should be grouped.
+> * Versions and sections should be linkable.
+> * The latest version comes first.
+> * The release date of each version is displayed.
+> * Mention whether you follow Semantic Versioning.
+
+Grouping changes into a clear set of change types:
+
+> * `Added` for new features.
+> * `Changed` for changes in existing functionality.
+> * `Deprecated` for soon-to-be removed features.
+> * `Removed` for now removed features.
+> * `Fixed` for any bug fixes.
+> * `Security` in case of vulnerabilities.
+
+Unlike automatic tools like github-changelog-generator, keep a changelog is a human-written, plain English summary of changes. It is **not** a commit log dump; please do not use it as such.
+
+We recommend that you and your team update the changelog within your Pull Requests, which avoids the need to add to the changelog much later, at release. Please read the [keep a changelog](https://keepachangelog.com/en/1.1.0/) website. It's a single page with lots of important advice about the benefits and dangers of an incomplete changelog, but as it says in the FAQs, you can always revisit and improve a changelog over time.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+To add a [keep a changelog v1.1.0](https://keepachangelog.com/en/1.1.0/) changelog to your project, use the following at the command line:
+
+```bash
+way_of_working init changelog
+```
+
+The Way of Working command line tool scaffolds a new changelog on new and longstanding projects.
+
+On longstanding git-based projects, it reads the release tags and scaffolds a changelog with the expected changes of a [semantically versioned](https://semver.org) project. So, for example, a patch or minor version change won't contain a scaffolded `Removed` section.
+
+Please use the links within the scaffolded changelog to view all the commits between releases to document historical changes.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/HealthDataInsight/way_of_working-changelog-keepachangelog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/HealthDataInsight/way_of_working-changelog-keepachangelog/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the WayOfWorking::Changelog::Keepachangelog project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/HealthDataInsight/way_of_working-changelog-keepachangelog/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'way_of_working/tasks'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = false
+  t.warning = false
+end
+
+desc 'Run tests'
+task default: :test

data/code_safety.yml

@@ -0,0 +1,130 @@
+---
+file safety:
+  ".alexrc":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  ".github/linters/.markdown-link-check.json":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: c6967c0cb2b341ab33d5d134af666c0a4e6ade7d
+  ".github/linters/rubocop_defaults.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: c6967c0cb2b341ab33d5d134af666c0a4e6ade7d
+  ".github/workflows/inclusive-language.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  ".github/workflows/main.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  ".github/workflows/mega-linter.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  ".gitignore":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  ".mega-linter.yml":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: c6967c0cb2b341ab33d5d134af666c0a4e6ade7d
+  ".rubocop":
+    comments:
+    reviewed_by: timgentry
+    safe_revision: c6967c0cb2b341ab33d5d134af666c0a4e6ade7d
+  CHANGELOG.md:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 2664c0424e3eb7d51f7b64062ad92f796cc315e1
+  Gemfile:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  Gemfile.lock:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  LICENSE.txt:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: c6967c0cb2b341ab33d5d134af666c0a4e6ade7d
+  README.md:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  Rakefile:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: c6967c0cb2b341ab33d5d134af666c0a4e6ade7d
+  bin/console:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  bin/setup:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: c6967c0cb2b341ab33d5d134af666c0a4e6ade7d
+  docs/way_of_working/changelog.md:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  lib/way_of_working/changelog/keepachangelog.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  lib/way_of_working/changelog/keepachangelog/generators/init.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  lib/way_of_working/changelog/keepachangelog/github_audit_rule.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  lib/way_of_working/changelog/keepachangelog/paths.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  lib/way_of_working/changelog/keepachangelog/plugin.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  lib/way_of_working/changelog/keepachangelog/templates/docs/way_of_working/changelog.md:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  lib/way_of_working/changelog/keepachangelog/version.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  test/test_helper.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: c6967c0cb2b341ab33d5d134af666c0a4e6ade7d
+  test/way_of_working/audit_github_stub_classes.rb:
+    comments:
+    reviewed_by: shilpigoeldev
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  test/way_of_working/changelog/keepachangelog/generators/init_test.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  test/way_of_working/changelog/keepachangelog/github_audit_rule_test.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  test/way_of_working/changelog/keepachangelog/zeitwerk_loader_test.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  test/way_of_working/changelog/keepachangelog_test.rb:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33
+  way_of_working-changelog-keepachangelog.gemspec:
+    comments:
+    reviewed_by: timgentry
+    safe_revision: 8d28755cd6dce363b605f02a432539c7d6411c33

data/docs/way_of_working/changelog.md

@@ -0,0 +1,73 @@
+---
+layout: page
+status: REQUIRED
+enforcement: manual
+---
+
+# Changelog
+
+![Keep a Changelog v1.1.0 badge][changelog-badge]
+
+## Purpose
+
+Maintain a human-readable project history that documents all notable changes between versions in plain English.
+
+## Scope
+
+All projects must maintain a changelog using [Keep a Changelog v1.1.0][keep-a-changelog] format.
+
+## Requirements
+
+- Human-written plain English summaries (not commit log dumps)
+- Entry for every version
+- Latest version listed first
+- Release date displayed for each version
+- Changes grouped by type: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`
+- Versions and sections must be linkable
+- Follow [Semantic Versioning][semver]
+- Update changelog within Pull Requests, not at release time
+
+## Setup
+
+Initialise a changelog for your project:
+
+```bash
+way_of_working init changelog
+```
+
+For git-based projects with existing releases, this scaffolds sections based on semantic version tags.
+
+## Usage
+
+1. Update the `Unreleased` section in each Pull Request
+2. Group changes under appropriate headings
+3. Write clear, user-focused descriptions
+4. Move `Unreleased` changes to a version section at release
+5. Use scaffolded commit links to document historical changes
+
+## Enforcement
+
+- Changelog updates required in Pull Request reviews
+- No automatic commit log dumps permitted
+
+## Examples
+
+```markdown
+## [1.2.0] - 2025-10-22
+
+### Added
+- User authentication via OAuth2
+- Export data to CSV functionality
+
+### Fixed
+- Memory leak in background job processor
+```
+
+## Resources
+
+- [Keep a Changelog][keep-a-changelog]
+- [Semantic Versioning][semver]
+
+[changelog-badge]: https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735
+[keep-a-changelog]: https://keepachangelog.com/en/1.1.0/
+[semver]: https://semver.org

data/lib/way_of_working/changelog/keepachangelog/generators/init.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'way_of_working/changelog/keepachangelog/paths'
+require 'way_of_working/git/repo_reader'
+
+module WayOfWorking
+  module Changelog
+    module Keepachangelog
+      module Generators
+        # This class generates the CHANGELOG.md file, generating sections based on
+        # git tags and commit messages (where possible).
+        class Init < Thor::Group
+          include Thor::Actions
+
+          source_root ::WayOfWorking::Changelog::Keepachangelog.source_root
+
+          HEADER_TEXT = <<~TEXT
+            # Changelog
+
+            All notable changes to this project will be documented in this file.
+
+            The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+            and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+          TEXT
+
+          def add_changelog_to_project
+            create_file 'CHANGELOG.md' do
+              HEADER_TEXT + releases + footer
+            end
+          end
+
+          def copy_way_of_working_documentation
+            copy_file 'docs/way_of_working/changelog.md'
+          end
+
+          private
+
+          def releases
+            text = "## [Unreleased]\n\n"
+            text += added_change_text(:minor)
+            text += deprecated_removed_fixed_security_text(:minor)
+
+            summary_tags.each do |summary_tag|
+              text += "## [#{summary_tag.version}] - " \
+                      "#{summary_tag.commit_date.strftime('%Y-%m-%d')}\n\n"
+
+              text += added_change_text(summary_tag.change_type)
+              text += deprecated_removed_fixed_security_text(summary_tag.change_type)
+            end
+
+            text
+          end
+
+          def added_change_text(tag_change_type)
+            return '' if tag_change_type == :patch
+
+            change_text('Added', 'Detail new feature(s) here', true) +
+              change_text('Change', 'Detail change(s) in existing functionality here',
+                          tag_change_type == :major)
+          end
+
+          def deprecated_removed_fixed_security_text(tag_change_type)
+            change_text('Deprecated', 'Detail soon-to-be removed features here') +
+              change_text('Removed', 'Detail removed features here', tag_change_type == :major) +
+              change_text('Fixed', 'Detail any bug fixes here', true) +
+              change_text('Security', 'Detail fixes to vulnerabilities here')
+          end
+
+          # This method adds all of the reference style markdown links
+          def footer
+            return '' if summary_tags.empty?
+
+            previous_tag = nil
+            footer_text = ''
+            summary_tags.each do |summary_tag|
+              footer_text += if previous_tag
+                               release_link(summary_tag.name, previous_tag.name, previous_tag.version)
+                             else
+                               release_link(summary_tag.name, 'HEAD', 'Unreleased')
+                             end
+
+              previous_tag = summary_tag
+            end
+
+            footer_text += "[#{previous_tag.version}]: #{url}/releases/tag/#{previous_tag.name}\n"
+
+            footer_text
+          end
+
+          def release_link(start_tag, end_tag, version)
+            "[#{version}]: #{url}/compare/#{start_tag}...#{end_tag}\n"
+          end
+
+          def change_text(type, description, likely = false)
+            text = "### #{type}\n\n- TODO: #{description}"
+            text += ' (if any)' unless likely
+            text += "\n\n"
+            text
+          end
+
+          def repo_reader
+            @repo_reader ||= ::WayOfWorking::Git::RepoReader.new(::Git.open('.'))
+          end
+
+          def summary_tags
+            @summary_tags ||= repo_reader.summary_tags.reverse
+          rescue ArgumentError
+            []
+          end
+
+          def url
+            @url ||= repo_reader.likely_upstream_remote_url
+          end
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/changelog/keepachangelog/github_audit_rule.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'way_of_working/audit/github/rules/base'
+
+module WayOfWorking
+  module Changelog
+    # The namespace for this plugin
+    module Keepachangelog
+      # This rule checks for the Pull Request template.
+      class GithubAuditRule < ::WayOfWorking::Audit::Github::Rules::Base
+        def validate
+          @errors << 'No Keep a Changelog CHANGELOG.md found' unless keep_a_changelog_found?
+        end
+
+        private
+
+        def keep_a_changelog_found?
+          response = @client.contents(@repo_name, path: 'CHANGELOG.md')
+          decoded_content = Base64.decode64(response.content)
+
+          decoded_content.include?('Keep a Changelog')
+        rescue Octokit::NotFound
+          false
+        end
+      end
+
+      ::WayOfWorking::Audit::Github::Rules::Registry.register(
+        GithubAuditRule, 'Keep a Changelog CHANGELOG.md'
+      )
+    end
+  end
+end

data/lib/way_of_working/changelog/keepachangelog/paths.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module WayOfWorking
+  module Changelog
+    # Mixin that provides a couple of pathname convenience methods
+    module Keepachangelog
+      class << self
+        def root
+          Pathname.new(File.expand_path('../../../..', __dir__))
+        end
+
+        def source_root
+          root.join('lib', 'way_of_working', 'changelog', 'keepachangelog', 'templates')
+        end
+      end
+    end
+  end
+end

data/lib/way_of_working/changelog/keepachangelog/plugin.rb

@@ -0,0 +1,13 @@
+require 'way_of_working/changelog/keepachangelog'
+
+# Add any plug specific code here
+
+module WayOfWorking
+  module Changelog
+    module Keepachangelog
+      # This makes zeitwerk happy, which makes us happy too
+      module Plugin
+      end
+    end
+  end
+end

data/lib/way_of_working/changelog/keepachangelog/templates/docs/way_of_working/changelog.md

@@ -0,0 +1,73 @@
+---
+layout: page
+status: REQUIRED
+enforcement: manual
+---
+
+# Changelog
+
+![Keep a Changelog v1.1.0 badge][changelog-badge]
+
+## Purpose
+
+Maintain a human-readable project history that documents all notable changes between versions in plain English.
+
+## Scope
+
+All projects must maintain a changelog using [Keep a Changelog v1.1.0][keep-a-changelog] format.
+
+## Requirements
+
+- Human-written plain English summaries (not commit log dumps)
+- Entry for every version
+- Latest version listed first
+- Release date displayed for each version
+- Changes grouped by type: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`
+- Versions and sections must be linkable
+- Follow [Semantic Versioning][semver]
+- Update changelog within Pull Requests, not at release time
+
+## Setup
+
+Initialise a changelog for your project:
+
+```bash
+way_of_working init changelog
+```
+
+For git-based projects with existing releases, this scaffolds sections based on semantic version tags.
+
+## Usage
+
+1. Update the `Unreleased` section in each Pull Request
+2. Group changes under appropriate headings
+3. Write clear, user-focused descriptions
+4. Move `Unreleased` changes to a version section at release
+5. Use scaffolded commit links to document historical changes
+
+## Enforcement
+
+- Changelog updates required in Pull Request reviews
+- No automatic commit log dumps permitted
+
+## Examples
+
+```markdown
+## [1.2.0] - 2025-10-22
+
+### Added
+- User authentication via OAuth2
+- Export data to CSV functionality
+
+### Fixed
+- Memory leak in background job processor
+```
+
+## Resources
+
+- [Keep a Changelog][keep-a-changelog]
+- [Semantic Versioning][semver]
+
+[changelog-badge]: https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735
+[keep-a-changelog]: https://keepachangelog.com/en/1.1.0/
+[semver]: https://semver.org

data/lib/way_of_working/changelog/keepachangelog/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WayOfWorking
+  module Changelog
+    module Keepachangelog
+      VERSION = '1.0.0'
+    end
+  end
+end

data/lib/way_of_working/changelog/keepachangelog.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'way_of_working'
+require_relative 'keepachangelog/paths'
+require 'zeitwerk'
+
+# If way_of_working-audit-github is used we can add a rule
+begin
+  require 'way_of_working/audit/github/rules/registry'
+  require_relative 'keepachangelog/github_audit_rule'
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end
+
+loader = Zeitwerk::Loader.for_gem_extension(WayOfWorking::Changelog)
+loader.setup
+
+module WayOfWorking
+  module Changelog
+    module Keepachangelog
+      class Error < StandardError; end
+    end
+  end
+
+  module SubCommands
+    # This reopens the "way_of_working init" sub command
+    class Init
+      register(Changelog::Keepachangelog::Generators::Init, 'changelog', 'changelog',
+               <<~LONGDESC)
+                 Description:
+                     This adds the Keep a Changelog v1.1 changelog to the project
+
+                 Example:
+                     way_of_working init changelog
+
+                     This will create:
+                     CHANGELOG.md
+               LONGDESC
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: way_of_working-changelog-keepachangelog
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Gentry
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: way_of_working
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.18
+description:
+email:
+- 52189+timgentry@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".alexrc"
+- ".mega-linter.yml"
+- ".rubocop"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- code_safety.yml
+- docs/way_of_working/changelog.md
+- lib/way_of_working/changelog/keepachangelog.rb
+- lib/way_of_working/changelog/keepachangelog/generators/init.rb
+- lib/way_of_working/changelog/keepachangelog/github_audit_rule.rb
+- lib/way_of_working/changelog/keepachangelog/paths.rb
+- lib/way_of_working/changelog/keepachangelog/plugin.rb
+- lib/way_of_working/changelog/keepachangelog/templates/docs/way_of_working/changelog.md
+- lib/way_of_working/changelog/keepachangelog/version.rb
+homepage: https://github.com/HealthDataInsight/way_of_working-changelog-keepachangelog
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/HealthDataInsight/way_of_working-changelog-keepachangelog
+  source_code_uri: https://github.com/HealthDataInsight/way_of_working-changelog-keepachangelog
+  changelog_uri: https://github.com/HealthDataInsight/way_of_working-changelog-keepachangelog/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Way of Working plugin for a Changelog using Keep a Changelog
+test_files: []