Contents

# typed: true

module CodeOwnership
  module Private
    module TeamPlugins
      class Github < CodeTeams::Plugin
        extend T::Sig
        extend T::Helpers

        GithubStruct = Struct.new(:team, :do_not_add_to_codeowners_file)

        sig { returns(GithubStruct) }
        def github
          raw_github = @team.raw_hash['github'] || {}

          GithubStruct.new(
            raw_github['team'],
            raw_github['do_not_add_to_codeowners_file'] || false
          )
        end

        sig { override.params(teams: T::Array[CodeTeams::Team]).returns(T::Array[String]) }
        def self.validation_errors(teams)
          all_github_teams = teams.flat_map { |team| self.for(team).github.team }.compact

          teams_used_more_than_once = all_github_teams.tally.select do |_team, count|
            count > 1
          end

          errors = T.let([], T::Array[String])

          if require_github_teams?
            missing_github_teams = teams.select { |team| self.for(team).github.team.nil? }

            if missing_github_teams.any?
              errors << <<~ERROR
                The following teams are missing `github.team` entries:

                #{missing_github_teams.map(&:config_yml).join("\n")}
              ERROR
            end
          end

          if teams_used_more_than_once.any?
            errors << <<~ERROR
              The following teams are specified multiple times:
              Each code team must have a unique GitHub team in order to write the CODEOWNERS file correctly.

              #{teams_used_more_than_once.keys.join("\n")}
            ERROR
          end

          errors
        end

        sig { returns(T::Boolean) }
        def self.require_github_teams?
          CodeOwnership.configuration.require_github_teams
        end
      end
    end
  end
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version	Path
code_ownership-1.38.3	lib/code_ownership/private/team_plugins/github.rb
code_ownership-1.38.2	lib/code_ownership/private/team_plugins/github.rb
code_ownership-1.38.1	lib/code_ownership/private/team_plugins/github.rb
code_ownership-1.38.0	lib/code_ownership/private/team_plugins/github.rb
code_ownership-1.37.0	lib/code_ownership/private/team_plugins/github.rb
code_ownership-1.36.3	lib/code_ownership/private/team_plugins/github.rb
code_ownership-1.36.2	lib/code_ownership/private/team_plugins/github.rb
code_ownership-1.36.1	lib/code_ownership/private/team_plugins/github.rb
code_ownership-1.36.0	lib/code_ownership/private/team_plugins/github.rb
code_ownership-1.35.0	lib/code_ownership/private/team_plugins/github.rb