feature_map 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a0dcdb071ddc3f13c6b54a523bcc537f863b257acf9a11df10efff8e7f5c6fe
-  data.tar.gz: 6267a5894214c5a5e09c318e09a2e7e38be8db2ff57e3b2f921a122e0bb2efaa
+  metadata.gz: 6a939e8112b0e1f3fd05c92db1292c6b5fd8bb7551b06818c8269c81e620ab28
+  data.tar.gz: 377d23e954d590917ec165f882538a79082dfda2e44a111b0f25f771a6430bc5
 SHA512:
-  metadata.gz: 8139590d22a89de94fed09f0542b9fd4be48ced297955490c8d042462e47fd41930077ebc4509ef708b1b376725c46f34e584388e7fb579c78c64182fa32c51d
-  data.tar.gz: 5d878b6b3ba44784bba640cf7206b5caec0fee43668dffb009a06f0daf460805bad3f0a52f82fa3c21af859af9c7e574f22cb74d71609d5c98bd3d5113d6fbfe
+  metadata.gz: 78846256b085c0706f05f2a845fa2890486cab9a45603ef65d32f4bec53a5a777f80c7c457de51d50aa3bd732d9834f328442b39b5fa8b03c5e0633f0ebb4444
+  data.tar.gz: 2dc8a225029e728c61cd963d3007b568d3f95851279f91ba1af605ad99e4a450b99ecba2301dc22d183275d6c1f1871525b8f651cc84abda93c2587d2eb368ca

data/lib/feature_map/cli.rb

@@ -20,6 +20,12 @@ module FeatureMap
         test_pyramid!(argv)
       elsif command == 'additional_metrics'
         additional_metrics!(argv)
+      elsif command == 'github_pr_annotation'
+        github_pr_annotation!(argv)
+      elsif command == 'slack_release_log'
+        slack_release_log!(argv)
+      elsif command == 'slack_team_notifications'
+        slack_team_notifications!(argv)
       elsif command == 'for_file'
         for_file(argv)
       elsif command == 'for_feature'
@@ -33,6 +39,9 @@ module FeatureMap
             docs - generates feature documentation
             for_feature - find assignment information for a feature
             for_file - find feature assignment for a single file
+            github_pr_annotation - comments the features and metrics affected by a pull request and labels it
+            slack_release_log - posts the changes since the previous release to the release log thread in Slack
+            slack_team_notifications - posts each team's affected features for a release to the team's Slack channel
             test_coverage - generates per-feature test coverage statistics
             test_pyramid - generates per-feature test pyramid (unit, integration, regression) statistics
             additional_metrics - generates additional metrics per-feature (e.g. health score)
@@ -267,6 +276,48 @@ module FeatureMap
       FeatureMap.generate_additional_metrics!
     end
 
+    def self.github_pr_annotation!(argv)
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: bin/featuremap github_pr_annotation'
+
+        opts.on('--help', 'Shows this prompt') do
+          puts opts
+          exit
+        end
+      end
+      parser.parse!(argv)
+
+      FeatureMap.github_pr_annotation!
+    end
+
+    def self.slack_release_log!(argv)
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: bin/featuremap slack_release_log'
+
+        opts.on('--help', 'Shows this prompt') do
+          puts opts
+          exit
+        end
+      end
+      parser.parse!(argv)
+
+      FeatureMap.slack_release_log!
+    end
+
+    def self.slack_team_notifications!(argv)
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: bin/featuremap slack_team_notifications'
+
+        opts.on('--help', 'Shows this prompt') do
+          puts opts
+          exit
+        end
+      end
+      parser.parse!(argv)
+
+      FeatureMap.slack_team_notifications!
+    end
+
     # For now, this just returns feature assignment
     # Later, this could also return feature assignment errors about that file.
     def self.for_file(argv)

data/lib/feature_map/configuration.rb

@@ -1,6 +1,13 @@
 # @feature Core Library
+require 'erb'
+
 module FeatureMap
   class Configuration
+    GITHUB_PR_ANNOTATION_SECTION = 'github_pr_annotation'.freeze
+    SLACK_RELEASE_LOG_SECTION = 'slack_release_log'.freeze
+    SLACK_TEAM_NOTIFICATIONS_SECTION = 'slack_team_notifications'.freeze
+    COMMAND_SECTIONS = [GITHUB_PR_ANNOTATION_SECTION, SLACK_RELEASE_LOG_SECTION, SLACK_TEAM_NOTIFICATIONS_SECTION].freeze
+
     attr_reader :assigned_globs
     attr_reader :unassigned_globs
     attr_reader :unbuilt_gems_path
@@ -13,6 +20,7 @@ module FeatureMap
     attr_reader :repository
     attr_reader :documentation_site
     attr_reader :documentation_site_url
+    attr_reader :command_sections
 
     def initialize(
       assigned_globs: nil,
@@ -26,7 +34,8 @@ module FeatureMap
       code_cov: nil,
       repository: nil,
       documentation_site: nil,
-      documentation_site_url: nil
+      documentation_site_url: nil,
+      command_sections: nil
     )
       @assigned_globs = assigned_globs
       @unassigned_globs = unassigned_globs
@@ -40,10 +49,13 @@ module FeatureMap
       @repository = repository
       @documentation_site = documentation_site
       @documentation_site_url = documentation_site_url
+      @command_sections = command_sections || {}
     end
 
     def self.fetch
-      config_hash = YAML.load_file('.feature_map/config.yml')
+      full_hash = YAML.load(ERB.new(File.read('.feature_map/config.yml')).result) || {}
+      command_sections = full_hash.slice(*COMMAND_SECTIONS)
+      config_hash = full_hash.except(*COMMAND_SECTIONS)
 
       if config_hash.key?('require')
         config_hash['require'].each do |require_directive|
@@ -62,7 +74,8 @@ module FeatureMap
         code_cov: config_hash.fetch('code_cov', {}),
         repository: config_hash.fetch('repository', {}),
         documentation_site: config_hash.fetch('documentation_site', {}),
-        documentation_site_url: config_hash.fetch('documentation_site_url', nil)
+        documentation_site_url: config_hash.fetch('documentation_site_url', nil),
+        command_sections: command_sections
       )
     end
   end

data/lib/feature_map/private/configured_commands.rb

@@ -0,0 +1,94 @@
+# @feature Core Library
+# frozen_string_literal: true
+
+module FeatureMap
+  module Private
+    module ConfiguredCommands
+      def self.github_pr_annotation
+        run(Configuration::GITHUB_PR_ANNOTATION_SECTION) do |settings|
+          require 'octokit'
+          PullRequestAnnotator.new(
+            required(settings, Configuration::GITHUB_PR_ANNOTATION_SECTION, 'github_token'),
+            full_repo_name,
+            required(settings, Configuration::GITHUB_PR_ANNOTATION_SECTION, 'pr_number'),
+            settings['base_metrics_path'].to_s,
+            doc_site_base_url
+          ).announce
+        end
+      end
+
+      def self.slack_release_log
+        run(Configuration::SLACK_RELEASE_LOG_SECTION) do |settings|
+          require 'octokit'
+          require 'slack-ruby-client'
+          ReleaseLogPublisher.new(
+            required(settings, Configuration::SLACK_RELEASE_LOG_SECTION, 'github_token'),
+            full_repo_name,
+            display_name(settings),
+            doc_site_base_url,
+            main_branch,
+            settings['slack_api_token'].to_s,
+            settings['slack_app_user_id'].to_s,
+            settings['slack_channel'].to_s,
+            settings['slack_thread_parent_ts'].to_s
+          ).publish
+        end
+      end
+
+      def self.slack_team_notifications
+        run(Configuration::SLACK_TEAM_NOTIFICATIONS_SECTION) do |settings|
+          require 'octokit'
+          require 'faraday'
+          TeamReleaseNotifier.new(
+            required(settings, Configuration::SLACK_TEAM_NOTIFICATIONS_SECTION, 'release_ref'),
+            required(settings, Configuration::SLACK_TEAM_NOTIFICATIONS_SECTION, 'github_token'),
+            full_repo_name,
+            display_name(settings),
+            (settings['teams'] || {}).transform_values(&:to_s)
+          ).notify
+        end
+      end
+
+      def self.run(section_name)
+        settings = Private.configuration.command_sections[section_name]
+        unless settings
+          puts "'#{section_name}' is not configured in .feature_map/config.yml. Skipping."
+          return
+        end
+
+        yield settings
+      end
+
+      def self.required(settings, section_name, key)
+        value = settings[key].to_s
+        raise "'#{section_name}.#{key}' must be set in .feature_map/config.yml" if value.empty?
+
+        value
+      end
+
+      def self.display_name(settings)
+        settings['display_name'].to_s.empty? ? full_repo_name.split('/').last : settings['display_name'].to_s
+      end
+
+      def self.full_repo_name
+        repository_url = Private.configuration.repository['url'].to_s
+        raise "'repository.url' must be set in .feature_map/config.yml" if repository_url.empty?
+
+        URI.parse(repository_url).path.delete_prefix('/').delete_suffix('.git')
+      end
+
+      def self.main_branch
+        Private.configuration.repository['main_branch'].to_s.empty? ? 'main' : Private.configuration.repository['main_branch']
+      end
+
+      def self.doc_site_base_url
+        url = Private.configuration.documentation_site_url.to_s
+        raise "'documentation_site_url' must be set in .feature_map/config.yml" if url.empty?
+
+        "#{url}#/"
+      end
+
+      private_class_method :run, :required, :display_name, :full_repo_name, :main_branch, :doc_site_base_url
+    end
+  end
+end

data/lib/feature_map/private/pull_request_annotator.rb

@@ -0,0 +1,294 @@
+# @feature Core Library
+# frozen_string_literal: true
+
+module FeatureMap
+  module Private
+    class PullRequestAnnotator
+      METRICS_FILE_PATH = '.feature_map/metrics.yml'
+      COMMENT_MARKER = '<!-- FEATURE_ANALYSIS_COMMENT -->'
+      FEATURE_LABEL_COLOR = '0366d6'
+      FEATURE_METRIC_LABELS = {
+        'abc_size' => 'ABC Size',
+        'lines_of_code' => 'Lines of Code',
+        'cyclomatic_complexity' => 'Cyclomatic Complexity'
+      }.freeze
+
+      def initialize(github_token, full_repo_name, pr_number, base_branch_metrics_path, doc_site_base_url)
+        @client = Octokit::Client.new(access_token: github_token, auto_paginate: true)
+        @full_repo_name = full_repo_name
+        @pr_number = pr_number
+        @doc_site_base_url = doc_site_base_url
+        @base_branch_metrics_path = base_branch_metrics_path
+      end
+
+      def announce
+        unless File.exist?(@base_branch_metrics_path)
+          puts "Base metrics not found at '#{@base_branch_metrics_path}'. Skipping feature announcement."
+          return
+        end
+
+        changed_files = lookup_changed_files
+        affected_features = identify_affected_features(changed_files)
+        feature_metrics = gather_feature_metrics(affected_features)
+        update_or_create_comment(affected_features, feature_metrics)
+        update_labels(affected_features.keys)
+      end
+
+      private
+
+      def lookup_changed_files
+        files = @client.pull_request_files(@full_repo_name, @pr_number)
+        changed_files = files.map(&:filename)
+
+        puts "\nFinal changed files: #{changed_files.inspect}"
+        changed_files
+      rescue StandardError => e
+        puts "Error fetching PR files: #{e.message}"
+        []
+      end
+
+      def identify_affected_features(changed_files)
+        affected = {}
+
+        changed_files.each do |file|
+          feature = FeatureMap.for_file(file)
+          next unless feature
+
+          affected[feature] ||= []
+          affected[feature] << file
+        end
+
+        puts "All Affected Features: #{affected.keys}"
+
+        affected
+      end
+
+      def gather_feature_metrics(affected_features)
+        base_branch_metrics = load_base_branch_feature_metrics
+        pr_branch_metrics = load_pr_branch_feature_metrics
+
+        metrics = {}
+
+        affected_features.each_key do |feature|
+          next if !pr_branch_metrics[feature.name] || !base_branch_metrics[feature.name]
+
+          feature_metrics = {}
+          FEATURE_METRIC_LABELS.each_key do |metric|
+            pr_branch_value = pr_branch_metrics[feature.name][metric] || 0
+            base_branch_value = base_branch_metrics[feature.name][metric] || 0
+            feature_metrics[metric] = { 'base_branch' => base_branch_value, 'pr_branch' => pr_branch_value }
+          end
+          metrics[feature.name] = feature_metrics
+        end
+
+        puts "\nMetrics for Affected Features: #{metrics}"
+
+        metrics
+      end
+
+      def load_base_branch_feature_metrics
+        YAML.load_file(@base_branch_metrics_path)['features']
+      rescue StandardError => e
+        puts "Error loading #{@base_branch_metrics_path}: #{e.class} - #{e.message}"
+        {}
+      end
+
+      def load_pr_branch_feature_metrics
+        YAML.load_file(METRICS_FILE_PATH)['features']
+      rescue StandardError => e
+        puts "Error loading #{METRICS_FILE_PATH}: #{e.class} - #{e.message}"
+        {}
+      end
+
+      def build_feature_message(affected_features, feature_metrics)
+        message = []
+        message << COMMENT_MARKER
+
+        return nil if affected_features.empty?
+
+        message << "## 📢 Features Affected by this PR\n"
+        message.concat(build_feature_sections(affected_features, feature_metrics))
+
+        message.join("\n")
+      end
+
+      def build_feature_sections(affected_features, feature_metrics)
+        sections = []
+        affected_features
+          .sort_by { |feature, _files| feature.name }
+          .each_with_index do |(feature, files), index|
+            sections << build_feature_section(
+              feature.name,
+              files,
+              feature_metrics,
+              is_last: index == affected_features.length - 1
+            )
+          end
+        sections
+      end
+
+      def build_feature_section(feature_name, files, feature_metrics, is_last: false)
+        section = []
+        puts "\nBuilding section for feature: '#{feature_name}'"
+        definition = FeatureMap::CodeFeatures.find(feature_name)
+        puts "Found definition: #{definition.inspect}"
+
+        docs_url = "#{@doc_site_base_url}#{URI::DEFAULT_PARSER.escape(feature_name)}"
+
+        section << "\n"
+        section << "#{feature_name} - [View Documentation →](#{docs_url})\n"
+
+        section << '<details>'
+        section << "<summary>#{files.length} file(s) changed</summary>\n"
+        section << "\n<br>\n"
+
+        section << "**Description:** #{definition.raw_hash['description']}\n" if definition&.raw_hash&.dig('description')
+
+        section << '**Changed Files:**'
+        files.sort.each do |file|
+          section << "- `#{file}`"
+        end
+
+        section << "\n<br>\n"
+
+        section.concat(build_feature_metrics_table(feature_name, feature_metrics))
+
+        section << "\n</details>\n"
+        section << "\n<hr>\n" unless is_last
+        section.join("\n")
+      end
+
+      def build_feature_metrics_table(feature_name, feature_metrics)
+        return ['*No metrics found for this feature.*'] unless feature_metrics[feature_name]
+
+        table = []
+        table << '| Metric | Initial Value | Change in Value (pct) | Final Value |'
+        table << '|---|:---:|:---:|:---:|'
+
+        feature_metrics[feature_name].each do |metric_name, values|
+          metric_label = FEATURE_METRIC_LABELS[metric_name] || metric_name.gsub('_', ' ').capitalize
+          initial_value = values['base_branch'] || 0
+          ending_value = values['pr_branch'] || 0
+          absolute_change = (ending_value - initial_value).round(2)
+          percentage_change = (absolute_change.to_f / initial_value * 100).round(2)
+
+          table << "| #{metric_label} | #{initial_value} | #{absolute_change} (#{percentage_change}%) | #{ending_value} |"
+        end
+
+        table
+      end
+
+      def find_existing_comment
+        comments = @client.issue_comments(@full_repo_name, @pr_number)
+        comments.find { |comment| comment.body.start_with?(COMMENT_MARKER) }
+      end
+
+      def update_or_create_comment(affected_features, feature_metrics)
+        message = build_feature_message(affected_features, feature_metrics)
+
+        existing_comment = find_existing_comment
+        if existing_comment
+          if message
+            update_comment(existing_comment, message)
+            puts 'Comment updated'
+          else
+            delete_comment(existing_comment)
+            puts 'No features found; Comment removed'
+          end
+        elsif message
+          add_comment(message)
+          puts 'Comment created'
+        else
+          puts 'No features found; Comment skipped'
+        end
+      end
+
+      def update_labels(features)
+        current_labels = lookup_current_labels
+        feature_labels = current_labels.select do |label|
+          label.start_with?(FeatureMap::CodeFeatures::Feature::LABEL_PREFIX)
+        end
+        affected_feature_labels = features.map(&:label)
+
+        puts "\nLabel Management:"
+        puts "  Current feature labels: #{feature_labels.inspect}"
+        puts "  Features to be labeled: #{features.map(&:name).inspect}"
+
+        remove_feature_labels(feature_labels, affected_feature_labels)
+
+        add_feature_labels(feature_labels, affected_feature_labels)
+      end
+
+      def remove_feature_labels(feature_labels, affected_feature_labels)
+        feature_labels
+          .reject { |existing_label| affected_feature_labels.include?(existing_label) }
+          .each do |existing_label|
+            puts "  Removing: '#{existing_label}' (feature '#{existing_label}' no longer changed)"
+            remove_label(existing_label)
+          end
+      end
+
+      def add_feature_labels(feature_labels, affected_feature_labels)
+        affected_feature_labels.each do |label_name|
+          if feature_labels.include?(label_name)
+            puts "  Keeping: '#{label_name}'"
+          else
+            puts "  Adding: '#{label_name}'"
+            ensure_label_exists(label_name)
+            add_label(label_name)
+          end
+        end
+      end
+
+      def lookup_current_labels
+        issue = @client.issue(@full_repo_name, @pr_number)
+        issue.labels.map(&:name)
+      rescue StandardError => e
+        puts "Error fetching current labels: #{e.class} - #{e.message}"
+        []
+      end
+
+      def ensure_label_exists(label_name)
+        @client.label(@full_repo_name, label_name)
+      rescue Octokit::NotFound
+        create_label(label_name)
+      end
+
+      def add_comment(message)
+        @client.add_comment(@full_repo_name, @pr_number, message)
+      rescue StandardError => e
+        puts "Error adding comment: #{e.class} - #{e.message}"
+      end
+
+      def update_comment(existing_comment, message)
+        @client.update_comment(@full_repo_name, existing_comment.id, message)
+      rescue StandardError => e
+        puts "Error updating comment: #{e.class} - #{e.message}"
+      end
+
+      def delete_comment(existing_comment)
+        @client.delete_comment(@full_repo_name, existing_comment.id)
+      rescue StandardError => e
+        puts "Error deleting comment: #{e.class} - #{e.message}"
+      end
+
+      def create_label(label_name)
+        @client.add_label(@full_repo_name, label_name, FEATURE_LABEL_COLOR)
+      rescue StandardError => e
+        puts "Error creating label: #{e.class} - #{e.message}"
+      end
+
+      def add_label(label_name)
+        @client.add_labels_to_an_issue(@full_repo_name, @pr_number, [label_name])
+      rescue StandardError => e
+        puts "Error adding label: #{e.class} - #{e.message}"
+      end
+
+      def remove_label(label_name)
+        @client.remove_label(@full_repo_name, @pr_number, label_name)
+      rescue StandardError => e
+        puts "Error removing label: #{e.class} - #{e.message}"
+      end
+    end
+  end
+end

data/lib/feature_map/private/release_log_publisher.rb

@@ -0,0 +1,301 @@
+# @feature Core Library
+# frozen_string_literal: true
+
+module FeatureMap
+  module Private
+    class ReleaseLogPublisher
+      MAX_COMMITS_PER_RELEASE = 100
+      MAX_RELEASE_LOG_MESSAGE_AGE_IN_SECONDS = (24 * 60 * 60)
+
+      MAX_FEATURES_PER_COMMIT = 5
+      MAX_RELEASE_OUTLINE_BULLETS = 47
+
+      attr_reader :github_client, :full_repo_name, :display_name, :main_branch, :slack_api_token, :slack_app_user_id, :slack_channel,
+                  :slack_thread_parent_ts, :doc_site_base_url
+
+      def initialize(github_token, full_repo_name, display_name, doc_site_base_url, main_branch, slack_api_token, slack_app_user_id, slack_channel, slack_thread_parent_ts)
+        @github_client = Octokit::Client.new(access_token: github_token)
+        @full_repo_name = full_repo_name
+        @display_name = display_name
+        @main_branch = main_branch
+        @slack_api_token = slack_api_token
+        @slack_app_user_id = slack_app_user_id
+        @slack_channel = slack_channel
+        @slack_thread_parent_ts = slack_thread_parent_ts
+        @doc_site_base_url = doc_site_base_url
+      end
+
+      def publish
+        previous_release_tag = find_previous_release_tag
+
+        commits = commits_since_release(previous_release_tag)
+        if commits.empty?
+          puts "No pending commits found.\n"
+          return
+        end
+
+        puts "Commits since last release:\n#{commits}\n\n"
+
+        features_by_commit = identify_features_for_commits(commits)
+
+        current_commit_sha = commits.first.sha
+        slack_message_blocks = build_release_log_message(features_by_commit, previous_release_tag, current_commit_sha)
+        post_release_log(slack_message_blocks)
+      end
+
+      private
+
+      def commits_since_release(release_tag)
+        commit_logs_since(release_tag).map do |commit_log|
+          commit_info = commit_log.split
+
+          sha = commit_info.shift
+          pull_request_number = commit_info.pop[2..-2] if commit_info.last.match?(/^\(#[0-9]+\)$/i)
+          description = commit_info.join(' ')
+          files = `git show --pretty="" --name-only #{sha}`.split("\n")
+
+          FeatureMap::Commit.new(sha:, description:, pull_request_number:, files:)
+        end
+      end
+
+      def commit_logs_since(release_tag)
+        load_repo_history
+        fetch_tag(release_tag)
+
+        commit_logs_command = "git log --oneline --decorate-refs-exclude=refs/tags \"#{release_tag}\"..\"origin/#{main_branch}\""
+        puts "Running '#{commit_logs_command}' to identify commits since release #{release_tag}\n"
+        commit_logs_in_current_release = `#{commit_logs_command}`
+        commit_logs_in_current_release.split("\n")
+      end
+
+      def find_previous_release_tag
+        releases = github_client.releases(full_repo_name)
+        published_releases = releases.reject { |release| release.draft || release.prerelease }
+
+        return published_releases.first.tag_name unless published_releases.empty?
+
+        raise 'No prior release found.'
+      end
+
+      def load_repo_history
+        `git fetch --depth #{MAX_COMMITS_PER_RELEASE} origin #{main_branch}`
+      end
+
+      def fetch_tag(tag_name)
+        command = "git fetch -n origin refs/tags/#{tag_name}:refs/tags/#{tag_name}"
+
+        puts "Running '#{command}' to fetch tag #{tag_name}\n"
+        `#{command}`
+      end
+
+      def identify_features_for_commits(commits)
+        commits.to_h do |commit|
+          [commit, commit.files.map { |file| FeatureMap.for_file(file) }.compact.uniq]
+        end
+      end
+
+      def build_release_log_message(features_by_commit, release_tag, current_commit_sha)
+        if features_by_commit.empty?
+          puts "No changes identified since previous release. Skipping notification.\n"
+          return
+        end
+
+        compare_url = github_compare_url(release_tag, current_commit_sha)
+        message_blocks = build_header_blocks(compare_url, current_commit_sha) +
+                         build_release_outline(features_by_commit, compare_url)
+        puts "Release Log Message Content:\n#{message_blocks.to_json}\n\n"
+
+        message_blocks
+      end
+
+      def post_release_log(message_blocks)
+        required_configurations = [
+          { value: slack_api_token, label: 'Slack API token' },
+          { value: slack_channel, label: 'target Slack channel' },
+          { value: slack_thread_parent_ts, label: 'parent Slack message timestamp' }
+        ]
+        return unless required_configurations.all? do |required_config|
+          if required_config[:value].nil? || required_config[:value].empty?
+            puts "No #{required_config[:label]} configured. Skipping notification delivery.\n\n"
+            next false
+          end
+          true
+        end
+
+        puts 'Verifying Slack Client authentication...'
+        slack_client.auth_test
+
+        puts "Posting release log message to thread in #{slack_channel}..."
+        slack_client.chat_postMessage(channel: slack_channel, blocks: message_blocks, thread_ts: slack_thread_parent_ts)
+
+        remove_outdated_release_log_messages
+      end
+
+      def remove_outdated_release_log_messages
+        if slack_app_user_id.nil? || slack_app_user_id.empty?
+          puts "No Slack user ID configured for the Slack app. Skipping past release log cleanup.\n\n"
+          return
+        end
+
+        puts "Fetching release log messages for this repo from thread in #{slack_channel}..."
+        thread_messages_response = slack_client.conversations_replies(channel: slack_channel, ts: slack_thread_parent_ts)
+
+        unless thread_messages_response['ok']
+          puts "Outdated release log message retrieval failed: #{thread_messages_response.to_json}"
+          raise 'Failed to retrieve outdated release log messages.'
+        end
+
+        messages_to_delete = thread_messages_response['messages'].filter { |message| outdated_message?(message) }
+
+        puts "Found #{messages_to_delete.length} outdated messages in the release log thread for this repo to be deleted."
+        messages_to_delete.each do |message_data|
+          delete_outdated_message(message_data)
+        end
+
+        puts 'All outdated messages deleted.'
+      end
+
+      def delete_outdated_message(message_data)
+        slack_client.chat_delete(channel: slack_channel, ts: message_data['ts'])
+      rescue Slack::Web::Api::Errors::MessageNotFound => e
+        puts "Message #{message_data['ts']} was already deleted: #{e.message}"
+      end
+
+      def outdated_message?(slack_message)
+        !slack_message['user'].nil? &&
+          !slack_message['ts'].nil? &&
+          slack_message['user'] == slack_app_user_id &&
+          slack_message['ts'].split('.').first.to_i < oldest_relevant_message_ts
+      end
+
+      def oldest_relevant_message_ts
+        @oldest_relevant_message_ts ||= (Time.now - MAX_RELEASE_LOG_MESSAGE_AGE_IN_SECONDS).to_i
+      end
+
+      def github_compare_url(release_tag, current_commit_sha)
+        "https://github.com/#{full_repo_name}/compare/#{release_tag}...#{current_commit_sha}"
+      end
+
+      def build_header_blocks(compare_url, current_commit_sha)
+        [
+          {
+            type: 'header',
+            text: {
+              type: 'plain_text',
+              text: ":shipit: #{display_name} Changes"
+            }
+          },
+          {
+            type: 'section',
+            text: {
+              type: 'mrkdwn',
+              text: "Current Commit: <#{compare_url}|#{current_commit_sha}>\n"
+            }
+          }
+        ]
+      end
+
+      def build_release_outline(features_by_commit, compare_url)
+        return [] if features_by_commit.empty?
+
+        bullets_by_commit = features_by_commit.map do |commit, features|
+          [build_commit_bullet(commit)] + build_feature_sub_bullets(features)
+        end
+
+        return [build_rich_text_block(bullets_by_commit.flatten)] if bullets_by_commit.sum(&:length) <= MAX_RELEASE_OUTLINE_BULLETS
+
+        included_bullets = fit_commit_bullets(bullets_by_commit, MAX_RELEASE_OUTLINE_BULLETS - 1)
+        omitted_commit_count = bullets_by_commit.length - included_bullets.length
+
+        [
+          build_rich_text_block(included_bullets.flatten),
+          build_truncation_notice_block(omitted_commit_count, compare_url)
+        ]
+      end
+
+      def fit_commit_bullets(bullets_by_commit, bullet_budget)
+        bullet_count = 0
+        bullets_by_commit.take_while do |commit_bullets|
+          bullet_count += commit_bullets.length
+          bullet_count <= bullet_budget
+        end
+      end
+
+      def build_rich_text_block(bullets)
+        {
+          type: 'rich_text',
+          elements: bullets
+        }
+      end
+
+      def build_truncation_notice_block(omitted_commit_count, compare_url)
+        commits_label = omitted_commit_count == 1 ? 'commit' : 'commits'
+
+        {
+          type: 'section',
+          text: {
+            type: 'mrkdwn',
+            text: ":warning: Message truncated to fit Slack's limits. #{omitted_commit_count} older #{commits_label} " \
+                  "not shown. <#{compare_url}|View the full comparison on GitHub>"
+          }
+        }
+      end
+
+      def build_commit_bullet(commit)
+        commit_description_details = [{ type: 'text', text: commit.description }]
+
+        if commit.pull_request_number
+          commit_description_details << { type: 'text', text: ' (' }
+          commit_description_details << { type: 'link', url: "https://github.com/#{full_repo_name}/pull/#{commit.pull_request_number}", text: "##{commit.pull_request_number}" }
+          commit_description_details << { type: 'text', text: ')' }
+        end
+
+        slack_list_item(0, commit_description_details)
+      end
+
+      def build_feature_sub_bullets(features)
+        return [slack_list_item(1, [{ type: 'text', text: 'No Feature' }])] if features.empty?
+
+        features
+          .first(MAX_FEATURES_PER_COMMIT)
+          .map { |feature| build_feature_sub_bullet(feature) }
+          .tap do |feature_bullets|
+            additional_features_count = features.length - MAX_FEATURES_PER_COMMIT
+            next unless additional_features_count.positive?
+
+            features_label = additional_features_count > 1 ? 'features' : 'feature'
+            feature_bullets << slack_list_item(1,
+                                               [{ type: 'text',
+                                                  text: "And #{additional_features_count} other #{features_label}..." }])
+          end
+      end
+
+      def build_feature_sub_bullet(feature)
+        feature_description_details = [{ type: 'text', text: "#{feature.name} (" }]
+        doc_site_url = "#{doc_site_base_url}#{URI::DEFAULT_PARSER.escape(feature.name)}"
+        feature_description_details << { type: 'link', url: doc_site_url, text: 'View Documentation' }
+        feature_description_details << { type: 'text', text: ')' }
+
+        slack_list_item(1, feature_description_details)
+      end
+
+      def slack_list_item(indent, elements)
+        {
+          type: 'rich_text_list',
+          style: 'bullet',
+          indent:,
+          elements: [
+            {
+              type: 'rich_text_section',
+              elements:
+            }
+          ]
+        }
+      end
+
+      def slack_client
+        @slack_client ||= Slack::Web::Client.new(token: slack_api_token)
+      end
+    end
+  end
+end

data/lib/feature_map/private/team_release_notifier.rb

@@ -0,0 +1,118 @@
+# @feature Core Library
+# frozen_string_literal: true
+
+module FeatureMap
+  module Private
+    class TeamReleaseNotifier
+      MAX_COMMITS_PER_RELEASE = 100
+
+      attr_reader :release_tag, :github_client, :full_repo_name, :display_name, :team_slack_webhooks
+
+      def initialize(release_ref, github_token, full_repo_name, display_name, team_slack_webhooks)
+        unless release_ref.start_with?('refs/tags/')
+          raise "Release commit reference must be a tag (i.e. start with 'refs/tags/'). Received value: #{release_ref}"
+        end
+
+        @release_tag = release_ref[10..]
+        @github_client = Octokit::Client.new(access_token: github_token)
+        @full_repo_name = full_repo_name
+        @display_name = display_name
+        @team_slack_webhooks = team_slack_webhooks
+      end
+
+      def notify
+        commits = lookup_commits_in_release
+        puts "Commits in release #{release_tag}:\n#{commits}\n\n"
+
+        grouped_commits = FeatureMap.group_commits(commits)
+
+        deliver_release_notifications(grouped_commits)
+      end
+
+      private
+
+      def lookup_commits_in_release
+        commit_logs_in_current_release.map do |commit_log|
+          commit_info = commit_log.split
+
+          sha = commit_info.shift
+          pull_request_number = commit_info.pop[2..-2] if commit_info.last.match?(/^\(#[0-9]+\)$/i)
+          description = commit_info.join(' ')
+          files = `git show --pretty="" --name-only #{sha}`.split("\n")
+
+          FeatureMap::Commit.new(sha:, description:, pull_request_number:, files:)
+        end
+      end
+
+      def commit_logs_in_current_release
+        previous_release_tag = lookup_previous_release_tag
+
+        load_repo_history
+        fetch_tag(previous_release_tag)
+        fetch_tag(release_tag)
+
+        command = "git log --oneline --decorate-refs-exclude=refs/tags \"#{previous_release_tag}\"..\"#{release_tag}\""
+        puts "Running '#{command}' to identify commits in release #{release_tag}\n"
+        commit_logs_in_current_release = `#{command}`
+        commit_logs_in_current_release.split("\n")
+      end
+
+      def lookup_previous_release_tag
+        releases = github_client.releases(full_repo_name)
+        published_releases = releases.reject { |release| release.draft || release.prerelease }
+
+        published_releases.each_with_index do |release, index|
+          return published_releases[index + 1].tag_name if release.tag_name == release_tag
+        end
+
+        raise "No prior release found. Current release tag: #{release_tag}"
+      end
+
+      def load_repo_history
+        `git fetch --depth #{MAX_COMMITS_PER_RELEASE} origin #{release_tag}`
+      end
+
+      def fetch_tag(tag_name)
+        command = "git fetch -n origin refs/tags/#{tag_name}:refs/tags/#{tag_name}"
+
+        puts "Running '#{command}' to fetch tag #{tag_name}\n"
+        `#{command}`
+      end
+
+      def deliver_release_notifications(grouped_commits)
+        team_slack_webhooks.each do |team_name, slack_webhook|
+          if !grouped_commits[team_name] || grouped_commits[team_name].empty?
+            puts "No features for the #{team_name} Team impacted by release #{release_tag}. Skipping notification.\n"
+            next
+          end
+
+          message_blocks = FeatureMap.generate_release_notification(grouped_commits[team_name])
+
+          message_blocks = [header_block] + message_blocks
+          puts "Full Message Content for #{team_name} Team:\n#{message_blocks.to_json}\n"
+          if slack_webhook.nil? || slack_webhook.empty?
+            puts "No Slack webhook configured for team #{team_name}. Skipping notification delivery.\n\n"
+            next
+          end
+
+          post_team_notification(slack_webhook, message_blocks)
+          puts "Delivered release notification to team #{team_name}\n\n"
+        end
+      end
+
+      def header_block
+        {
+          type: 'header',
+          text: {
+            type: 'plain_text',
+            text: ":shipit: #{release_tag} Released in #{display_name}"
+          }
+        }
+      end
+
+      def post_team_notification(slack_webhook, message_blocks)
+        Faraday.post(slack_webhook, { blocks: message_blocks }.to_json, { 'Content-Type' => 'application/json' })
+      end
+    end
+  end
+end

data/lib/feature_map/private.rb

@@ -35,9 +35,15 @@ require 'feature_map/private/assignment_mappers/feature_globs'
 require 'feature_map/private/assignment_mappers/directory_assignment'
 require 'feature_map/private/assignment_mappers/feature_definition_assignment'
 require 'feature_map/private/release_notification_builder'
+require 'feature_map/private/pull_request_annotator'
+require 'feature_map/private/release_log_publisher'
+require 'feature_map/private/team_release_notifier'
+require 'feature_map/private/configured_commands'
 
 module FeatureMap
   module Private
+    DOCUMENTATION_SITE_CONFIGURATION_KEYS = %w[documentation_site repository].freeze
+
     def self.apply_assignments!(assignments_file_path)
       assignments = CSV.read(assignments_file_path)
       AssignmentApplicator.apply_assignments!(assignments)
@@ -102,7 +108,7 @@ module FeatureMap
         feature_test_coverage,
         feature_test_pyramid,
         feature_additional_metrics,
-        configuration.raw_hash,
+        configuration.raw_hash.slice(*DOCUMENTATION_SITE_CONFIGURATION_KEYS),
         git_ref || configuration.repository['main_branch']
       )
     end

data/lib/feature_map.rb

@@ -227,6 +227,18 @@ module FeatureMap
     Mapper.all.each(&:bust_caches!)
   end
 
+  def self.github_pr_annotation!
+    Private::ConfiguredCommands.github_pr_annotation
+  end
+
+  def self.slack_release_log!
+    Private::ConfiguredCommands.slack_release_log
+  end
+
+  def self.slack_team_notifications!
+    Private::ConfiguredCommands.slack_team_notifications
+  end
+
   def self.configuration
     Private.configuration
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feature_map
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Beyond Finance
@@ -51,6 +51,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: packs-specification
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +113,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: uri
   requirement: !ruby/object:Gem::Requirement
@@ -228,6 +268,7 @@ files:
 - lib/feature_map/private/assignment_mappers/file_annotations.rb
 - lib/feature_map/private/assignments_file.rb
 - lib/feature_map/private/code_cov.rb
+- lib/feature_map/private/configured_commands.rb
 - lib/feature_map/private/cyclomatic_complexity_calculator.rb
 - lib/feature_map/private/docs/index.html
 - lib/feature_map/private/documentation_site.rb
@@ -240,8 +281,11 @@ files:
 - lib/feature_map/private/lines_of_code_calculator.rb
 - lib/feature_map/private/metrics_file.rb
 - lib/feature_map/private/percentile_metrics_calculator.rb
+- lib/feature_map/private/pull_request_annotator.rb
+- lib/feature_map/private/release_log_publisher.rb
 - lib/feature_map/private/release_notification_builder.rb
 - lib/feature_map/private/simple_cov_resultsets.rb
+- lib/feature_map/private/team_release_notifier.rb
 - lib/feature_map/private/test_coverage_file.rb
 - lib/feature_map/private/test_pyramid/jest_mapper.rb
 - lib/feature_map/private/test_pyramid/mapper.rb