Skip to content

Fixed typo - #3826

Closed
takuyahara wants to merge 1 commit into
wailsapp:masterfrom
takuyahara:patch-2
Closed

takuyahara wants to merge 1 commit into
wailsapp:masterfrom
takuyahara:patch-2

Conversation

@takuyahara

@takuyahara takuyahara commented Oct 14, 2024 •

Copy link
Copy Markdown
Contributor
- - Uploading to platforms like S3, Supbase, etc.
+ - Uploading to platforms like S3, Supabase, etc.

Summary by CodeRabbit

  • New Features

    • Updated guidance on building Wails projects for multiple platforms using GitHub Actions.
    • Included example YAML configuration for GitHub Actions workflow with matrix strategy for Linux, Windows, and macOS builds.
  • Bug Fixes

    • Corrected the spelling of "Supbase" to "Supabase" in the enhancements list.

@coderabbitai

coderabbitai Bot commented Oct 14, 2024 •

Copy link
Copy Markdown
Contributor

Walkthrough

The document crossplatform-build.mdx has been updated to provide detailed guidance on building a Wails project across multiple platforms using GitHub Actions. It includes an introduction that highlights the necessity of separate builds for different operating systems and presents a YAML configuration example for the workflow. This example outlines the triggers, environment variables, job strategies, and steps involved, utilizing a matrix strategy for simultaneous builds on Linux, Windows, and macOS. Additionally, a minor correction was made from "Supbase" to "Supabase."

Changes

File Path Change Summary
website/versioned_docs/version-v2.9.0/guides/crossplatform-build.mdx Updated to include guidance on multi-platform builds using GitHub Actions, with YAML example and minor correction.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHubActions
    participant BuildSystem

    User->>GitHubActions: Trigger build
    GitHubActions->>BuildSystem: Start build for Linux
    GitHubActions->>BuildSystem: Start build for Windows
    GitHubActions->>BuildSystem: Start build for macOS
    BuildSystem-->>GitHubActions: Build results
    GitHubActions-->>User: Notify build completion
Loading

🐇 "In the meadow, we now can see,
Builds for all, as quick as can be!
With GitHub's help, we leap and bound,
Across each OS, our joy is found.
Supabase shines, our paths align,
Hopping forward, all is fine!" 🌼


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 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.

@sonarqubecloud

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 26ff639 and c18e9b6.

📒 Files selected for processing (1)
  • website/versioned_docs/version-v2.9.0/guides/crossplatform-build.mdx (1 hunks)
🧰 Additional context used

- Caching dependencies
- Code signing
- Uploading to platforms like S3, Supbase, etc.
- Uploading to platforms like S3, Supabase, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Multiple instances of "Supbase" typo found.

The script detected several instances of the typo "Supbase" across the codebase. Please correct these to "Supabase" in the following files:

  • website/versioned_docs/version-v2.8.1/guides/crossplatform-build.mdx
  • website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-v2.8.1/guides/crossplatform-build.mdx
  • website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-v2.9.0/guides/crossplatform-build.mdx
  • website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-v2.7.0/guides/crossplatform-build.mdx
  • website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-v2.8.1/guides/crossplatform-build.mdx
  • website/i18n/vi/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx
  • website/i18n/tr/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx
  • website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx
  • website/i18n/ko/docusaurus-plugin-content-docs/version-v2.9.0/guides/crossplatform-build.mdx
  • website/i18n/ko/docusaurus-plugin-content-docs/version-v2.7.0/guides/crossplatform-build.mdx
  • website/i18n/ko/docusaurus-plugin-content-docs/version-v2.8.0/guides/crossplatform-build.mdx
  • website/i18n/ko/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx
  • website/i18n/ko/docusaurus-plugin-content-docs/version-v2.8.1/guides/crossplatform-build.mdx
  • website/i18n/pt/docusaurus-plugin-content-docs/version-v2.8.0/guides/crossplatform-build.mdx
  • website/i18n/pt/docusaurus-plugin-content-docs/version-v2.8.1/guides/crossplatform-build.mdx
  • website/i18n/pt/docusaurus-plugin-content-docs/version-v2.9.0/guides/crossplatform-build.mdx
  • website/i18n/pt/docusaurus-plugin-content-docs/version-v2.7.0/guides/crossplatform-build.mdx
  • website/i18n/ru/docusaurus-plugin-content-docs/version-v2.9.0/guides/crossplatform-build.mdx
  • website/i18n/ru/docusaurus-plugin-content-docs/version-v2.8.0/guides/crossplatform-build.mdx
  • website/i18n/ru/docusaurus-plugin-content-docs/version-v2.8.1/guides/crossplatform-build.mdx
  • website/i18n/ru/docusaurus-plugin-content-docs/version-v2.7.0/guides/crossplatform-build.mdx
  • website/i18n/pt/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx
  • website/i18n/ru/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx
  • website/i18n/ja/docusaurus-plugin-content-docs/version-v2.8.1/guides/crossplatform-build.mdx
  • website/i18n/ja/docusaurus-plugin-content-docs/version-v2.9.0/guides/crossplatform-build.mdx
  • website/i18n/ja/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx
  • website/i18n/ja/docusaurus-plugin-content-docs/version-v2.8.0/guides/crossplatform-build.mdx
  • website/i18n/ja/docusaurus-plugin-content-docs/version-v2.7.0/guides/crossplatform-build.mdx
  • website/i18n/fr/docusaurus-plugin-content-docs/version-v2.9.0/guides/crossplatform-build.mdx
  • website/i18n/fr/docusaurus-plugin-content-docs/version-v2.8.1/guides/crossplatform-build.mdx
  • website/docs/guides/crossplatform-build.mdx
  • website/i18n/ar/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx

Please address these typos to ensure consistency and accuracy across all documentation.

🔗 Analysis chain

LGTM! Typo correction approved.

The change from "Supbase" to "Supabase" is correct and aligns with the PR objectives. This improves the accuracy of the documentation.

To ensure consistency across the codebase, let's verify if there are any other instances of this typo:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining instances of the "Supbase" typo

# Test: Search for "Supbase" in all files. Expect: No results
rg --type-add 'docs:*.{md,mdx}' --type docs 'Supbase'

Length of output: 4644

@leaanthony

Copy link
Copy Markdown
Member

Thanks for taking the time to do this. Could you please make the change to the non-versioned docs so we don't lose it in later releases? Thanks.

@takuyahara

Copy link
Copy Markdown
Contributor Author

@leaanthony I recreated PR in #3846.

@takuyahara takuyahara closed this Oct 22, 2024
@takuyahara
takuyahara deleted the patch-2 branch October 22, 2024 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants