Use main branch of spec for coverage

[lawrence-forooghian]

The PR containing chat lifecycle has now been merged.

Resolves #97.

Summary by CodeRabbit

• New Features

  • Updated the branch reference for fetching specifications to the "main" branch, enhancing the accuracy of coverage report generation.

• Bug Fixes

  • Improved error handling for loading commits, malformed files, and version mismatches, ensuring more reliable data processing.

[coderabbitai]

Walkthrough

The changes in this pull request primarily involve the BuildTool.swift file, specifically updating the branchName variable within the SpecCoverage struct from "chat-lifecycle" to "main". This modification affects the source branch for fetching the latest spec commit SHA, which is crucial for generating coverage reports. The struct also contains methods for fetching spec data and handling errors, utilizing asynchronous programming patterns for efficient processing.

Changes

File	Change Summary
Sources/BuildTool/BuildTool.swift	Updated branchName from "chat-lifecycle" to "main" in SpecCoverage struct.

Assessment against linked issues

Objective	Addressed	Explanation
Switch spec-coverage script to use main (#97)	✅

Possibly related PRs

• [ECO-4980] Add a script to show spec coverage #93: The changes in the main PR update the branchName variable in the SpecCoverage struct, which is directly related to the new spec-coverage job introduced in PR [ECO-4980] Add a script to show spec coverage #93 that utilizes the BuildTool for generating spec coverage reports.

Suggested reviewers

• umair-ably
• maratal

Poem

In the fields where bunnies play,
A branch named "main" leads the way.
With coverage reports, we hop and cheer,
For specs are clear, and the path is near!
Let's fetch the data, swift and bright,
In our cozy burrow, all feels right! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fd10691 and 88dfe0f.

📒 Files selected for processing (1)

• Sources/BuildTool/BuildTool.swift (1 hunks)

🔇 Additional comments (1)

Sources/BuildTool/BuildTool.swift (1)

501-501: LGTM! Verify main branch readiness.

The change from "chat-lifecycle" to "main" aligns with the PR objectives.

Let's verify the main branch setup:

✅ Verification successful

Verified: Main branch is default and spec file exists.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify main branch existence and spec file availability

# Check if main branch exists and is the default branch
gh api repos/ably/specification | jq -r '.default_branch'

# Verify spec file exists in main branch
curl -I https://raw.githubusercontent.com/ably/specification/main/textile/chat-features.textile

Length of output: 1352

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.