Merge branch 'main' into fix_cli_config

Author: swerner

.github/workflows/github_actions/actions/get_context_action.rb

@@ -0,0 +1,41 @@
+class GetContextAction < Sublayer::Actions::Base
+  def initialize(path:)
+    @path = path
+  end
+
+  def call
+    ignored_patterns = load_contextignore
+    files = get_files(ignored_patterns)
+    concatenate_files(files)
+  end
+
+  private
+
+  def load_contextignore
+    contextignore_path = File.join(@path, '.contextignore')
+    return [] unless File.exist?(contextignore_path)
+
+    File.readlines(contextignore_path).map(&:strip).reject do |line|
+      line.empty? || line.start_with?('#')
+    end
+  end
+
+  def get_files(ignored_patterns)
+    Dir.chdir(@path) do
+      all_files = `git ls-files`.split("\n")
+      all_files.reject do |file|
+        ignored_patterns.any? do |pattern|
+          File.fnmatch?(pattern, file) ||
+            file.start_with?(pattern.chomp('/'))
+        end
+      end
+    end
+  end
+
+  def concatenate_files(files)
+    files.map do |file|
+      content = File.read(File.join(@path, file))
+      "File: #{file}\n#{content}\n\n"
+    end.join
+  end
+end

.github/workflows/github_actions/actions/github_add_or_modify_file_action.rb

@@ -0,0 +1,49 @@
+class GithubAddOrModifyFileAction < Sublayer::Actions::Base
+  def initialize(repo:, branch:, file_path:, file_content:)
+    @client = Octokit::Client.new(access_token: ENV['ACCESS_TOKEN'])
+    @repo = repo
+    @branch = branch
+    @file_path = file_path
+    @file_content = file_content
+  end
+
+  def call
+    content = @client.contents(@repo, path: @file_path, ref: @branch)
+    @client.update_contents(
+      @repo,
+      @file_path,
+      "Updating #{@file_path}",
+      content.sha,
+      @file_content,
+      branch: @branch
+    )
+  end
+
+  def call
+    begin
+      # Try to fetch the file contents to get its SHA
+      content = @client.contents(@repo, path: @file_path, ref: @branch)
+
+      # If the file exists, update it
+      @client.update_contents(
+        @repo,
+        @file_path,
+        "Updating #{@file_path}",
+        content.sha,
+        @file_content,
+        branch: @branch
+      )
+      puts "File updated: #{@file_path}"
+    rescue Octokit::NotFound
+      # If the file does not exist, create it instead
+      @client.create_contents(
+        @repo,
+        @file_path,
+        "Creating #{@file_path}",
+        @file_content,
+        branch: @branch
+      )
+      puts "File created: #{@file_path}"
+    end
+  end
+end

.github/workflows/github_actions/actions/github_create_branch_action.rb

@@ -0,0 +1,13 @@
+class GithubCreateBranchAction < Sublayer::Actions::Base
+  def initialize(repo:, base_branch:, new_branch:)
+    @client = Octokit::Client.new(access_token: ENV['ACCESS_TOKEN'])
+    @repo = repo
+    @base_branch = base_branch
+    @new_branch = new_branch
+  end
+
+  def call
+    ref = @client.ref(@repo, "heads/#{@base_branch}")
+    @client.create_ref(@repo, "refs/heads/#{@new_branch}", ref.object.sha)
+  end
+end

.github/workflows/github_actions/actions/github_create_pull_request_action.rb

@@ -0,0 +1,14 @@
+class GithubCreatePullRequestAction < Sublayer::Actions::Base
+  def initialize(repo:, base:, head:, title:, body:)
+    @client = Octokit::Client.new(access_token: ENV["ACCESS_TOKEN"])
+    @repo = repo
+    @base = base
+    @head = head
+    @title = title
+    @body = body
+  end
+
+  def call
+    @client.create_pull_request(@repo, @base, @head, @title, @body)
+  end
+end

.github/workflows/github_actions/actions/github_get_diff_action.rb

@@ -0,0 +1,18 @@
+class GithubGetDiffAction < Sublayer::Actions::Base
+  def initialize(repo:, pr_number:)
+    @client = Octokit::Client.new(access_token: ENV['ACCESS_TOKEN'])
+    @repo = repo
+    @pr_number = pr_number
+  end
+
+  def call
+    pr_files = @client.pull_request_files(@repo, @pr_number)
+    pr_files.map do |file|
+      {
+        filename: file.filename,
+        status: file.status,
+        patch: file.patch
+      }
+    end
+  end
+end

.github/workflows/github_actions/generators/doc_update_generator.rb

@@ -0,0 +1,56 @@
+class DocUpdateGenerator < Sublayer::Generators::Base
+  TEMPLATE_CONTENT = File.read(File.join(__dir__, 'just_the_docs_template.md'))
+
+  llm_output_adapter type: :list_of_named_strings,
+    name: "files_and_contents",
+    description: "A list of files to update along with their corresponding updated contents",
+    item_name: "file_update",
+    attributes: [
+      { name: "explanation", description: "Brief explanation for how a change to a specified file makes progress towards the suggested update." },
+      { name: "file_path", description: "The path of the file to update" },
+      { name: "file_content", description: "The updated content for the file" }
+    ]
+
+  def initialize(suggestions:, doc_context:, code_context:, context_ignore_list:)
+    @suggestions = suggestions
+    @doc_context = doc_context
+    @code_context = code_context
+    @context_ignore_list = context_ignore_list
+  end
+
+  def generate
+    super
+  end
+
+  def prompt
+    <<~PROMPT
+      You are tasked to make changes in the documentation repository based on suggestions.
+
+      Use the following information to guide both tasks:
+
+      1. Code repository structure:
+      #{@code_context}
+
+      2. Documentation repository structure:
+      #{@doc_context}
+
+      3. Documentation update suggestions:
+      #{@suggestions}
+
+      4. Files excluded from updates (do not modify these files):
+      #{@context_ignore_list}
+
+      5. Example of doc format:
+      #{TEMPLATE_CONTENT}
+
+      Guidelines:
+      1. Do not make updates to any files excluded from updates
+      2. Follow the format given in the example as a template for the structure of your file
+      3. If a new page is added make sure to add them to the navigation as well
+      3. If a link is added make sure it leads to an existing page, or create the new page being referenced
+
+      Your task:
+      Generate the full updated content for each file in the documentation repository that should be changed according to the suggestions.
+    PROMPT
+  end
+end

.github/workflows/github_actions/generators/doc_update_necessity_generator.rb

@@ -0,0 +1,42 @@
+class DocUpdateNecessityGenerator < Sublayer::Generators::Base
+  llm_output_adapter type: :named_strings,
+    name: "doc_update_score",
+    description: "boolean and confidence score indicating if documentation changes are needed",
+    attributes: [
+      { name: "reasoning", description: "brief explanation for whether or not doc changes are needed" },
+      { name: "confidence", description: "number from 0 to 1 indicating confidence in the decision" },
+      { name: "needs_update", description: "boolean indicating if updates are needed" }
+    ]
+
+  def initialize(doc_context:, code_context:, diff:)
+    @doc_context = doc_context
+    @code_context = code_context
+    @diff = diff
+  end
+
+  def generate
+    super
+  end
+
+  def prompt
+    <<~PROMPT
+      Code diff:
+      #{@diff}
+
+      Code context:
+      #{@code_context}
+
+      Documentation context:
+      #{@doc_context}
+
+      Given the above code diff and context, determine if documentation updates are necessary.
+      Consider the following factors:
+      1. The significance of the changes
+      2. Whether the changes affect public APIs or user-facing features
+      3. If the changes introduce new concepts or modify existing ones
+      4. Whether the current documentation accurately reflects the changes
+
+      Based on this information, are documentation updates necessary?
+    PROMPT
+  end
+end

.github/workflows/github_actions/generators/doc_update_suggestion_generator.rb

@@ -0,0 +1,59 @@
+class DocUpdateSuggestionGenerator < Sublayer::Generators::Base
+  llm_output_adapter type: :list_of_named_strings,
+    name: "doc_update_suggestions",
+    description: "List of doc update suggestions with usefulness scores",
+    item_name: "suggestion",
+    attributes: [
+      { name: "suggestion", description: "description of the doc update suggestion and its reasoning" },
+      { name: "file_changes", description: "description of the files and their respective changes" },
+      { name: "usefulness_score", description: "A score from 1-10 indicating the usefulness of the suggestion" }, #unused
+      { name: "title", description: "doc update suggestion title" } #unused
+    ]
+
+  def initialize(code_context:, doc_context:, context_ignore_list:, diff:)
+    @code_context = code_context
+    @doc_context = doc_context
+    @context_ignore_list = context_ignore_list
+    @diff = diff
+  end
+
+  def generate
+    super
+  end
+
+  def prompt
+    <<~PROMPT
+      As an expert in documentation with a focus on concise and hierarchical organization. Consider the following:
+
+      1. Newest changes:
+      #{@diff}
+
+      1. Documentation repository context:
+      #{@doc_context}
+
+      2. Code repository context:
+      #{@code_context}
+
+      3. Files excluded from updates (do not modify these files):
+      #{@context_ignore_list}
+
+      You are tasked with generating detailed and specific suggestions for updating a documentation repository based on the newest changes to the code repository.
+
+      Generate documentation update suggestions, considering:
+      1. The appropriate level in the documentation hierarchy for each change (high-level concepts vs. specific details)
+      2. The impact of the changes on existing documentation (updates, additions, or removals)
+      3. The importance of each change for user understanding and API use
+      4. The need for examples or clarifications of new or modified functionality
+
+      For each suggestion
+      - Describe the suggestion and the reasoning behind it. Be specific.
+      - Meticulously describe the files and the changes that should be made in them.
+      - Indicate its usefulness, 10 being most useful and 1 being least, as a way of prioritizing which suggestion should be done first
+      - A succinct title that encapsulates the spirit of the suggestion
+
+      Guidelines:
+      1. Do not suggest changes to any files excluded from updates
+      2. Make the fewest number of suggestions possible to achieve the desired outcome
+    PROMPT
+  end
+end