Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove the SPM module map #2040

Merged
merged 1 commit into from
Feb 26, 2025
Merged

Remove the SPM module map #2040

merged 1 commit into from
Feb 26, 2025

Conversation

lawrence-forooghian
Copy link
Collaborator

@lawrence-forooghian lawrence-forooghian commented Feb 25, 2025 •
edited
Loading

Note: This PR is based on top of #2038; please review that one first.

This module map is not actually being used; per the SPM documentation it should be named module.modulemap.

I tried renaming it and there are a bunch of issues to fix, which would be a non-trivial task. So let's just get rid of this file for now, until we actually need it (e.g. if we do #2034 and switch to SPM for running tests, in which case the tests would need to be able to access the Private submodule).

Summary by CodeRabbit

This release addresses internal documentation and configuration improvements aimed at streamlining contribution processes and reducing complexity, all while maintaining a stable interface for users.

  • Documentation
    • Revised contribution guidelines to focus on a single, clear instruction for updating header configurations, thereby simplifying the process.
  • Chores
    • Removed a redundant internal module configuration, streamlining the framework’s setup for improved maintainability.

@lawrence-forooghian
Remove the SPM module map
0da2fec 
This module map is not actually being used; per [1] it should be named
`module.modulemap`.

I tried renaming it and there are a bunch of issues to fix, which would
be a non-trivial task. So let's just get rid of this file for now, until
we actually need it (e.g. if we do #2034 and switch to SPM for running
tests, in which case the tests would need to be able to access the
Private submodule).

[1] /~https://github.com/swiftlang/swift-package-manager/blob/main/Documentation/Usage.md#creating-c-language-targets
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Feb 25, 2025 •
edited
Loading

Walkthrough

The pull request updates the contribution guidelines by modifying the header declaration instructions. The documentation now instructs adding the header only to Source/Ably.modulemap, removing the previous reference to an additional module map file. Additionally, the Source/include/Ably.modulemap file—which defined the framework module Ably along with its private API declarations—has been deleted.

Changes

File(s) Change Summary
CONTRIBUTING.md Updated instructions to reference only Source/Ably.modulemap for the Private module header declaration, removing the reference to the extra file.
Source/.../Ably.modulemap Deleted file that previously defined the framework module Ably and encapsulated its private headers.

Suggested reviewers

  • umair-ably
  • maratal

Poem

I’m a rabbit in a code garden, hopping with glee,
Skipping over clutter to set our guidance free.
Removed old paths, cleared the maze,
In streamlined maps, my little code always plays.
With ears perked high and tail a-flutter,
I celebrate new changes with a joyful mutter!
🐇💻

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between af36ee9 and 0da2fec.

📒 Files selected for processing (2)
  • CONTRIBUTING.md (1 hunks)
  • Source/include/Ably.modulemap (0 hunks)
💤 Files with no reviewable changes (1)
  • Source/include/Ably.modulemap
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: check (macOS, test_macOS)
  • GitHub Check: check (tvOS, test_tvOS17_2)
  • GitHub Check: check
  • GitHub Check: build
  • GitHub Check: check (iOS, test_iOS17_2)
  • GitHub Check: check
🔇 Additional comments (1)
CONTRIBUTING.md (1)

48-48: Streamlined Header Declaration Instruction
The updated instruction now correctly directs contributors to add the header declaration to the Private module in the Source/Ably.modulemap file. This change aligns with the PR objectives of removing the unused module map (Source/include/Ably.modulemap) and simplifies the contribution process.

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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@lawrence-forooghian lawrence-forooghian mentioned this pull request Feb 25, 2025
Open
Base automatically changed from 2025-02-25-make-some-classes-private to main February 26, 2025 11:30
@lawrence-forooghian
Copy link
Collaborator Author

CI failure unrelated to contents of PR; merging.

@lawrence-forooghian lawrence-forooghian merged commit 3ed324b into main Feb 26, 2025
7 of 8 checks passed
@lawrence-forooghian lawrence-forooghian deleted the 2025-02-25-remove-SPM-modulemap branch February 26, 2025 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maratal maratal maratal approved these changes

@umair-ably umair-ably Awaiting requested review from umair-ably

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lawrence-forooghian @maratal