Add Release instructions

[pablopunk]

Summary by CodeRabbit

• Documentation
  • Added a dedicated release guide in our documentation, outlining the essential steps for preparing and publishing a new version. This structured guide simplifies the process, ensuring consistency and clarity in version updates and app distribution.

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new "Release" section has been added to the README file. This section documents a 16-step process for releasing a new version of Swift Shift. The steps include updating version and build numbers in Xcode, archiving, distributing, notarizing the app, creating a new branch, committing changes, tagging the release, pushing changes, drafting a GitHub release, generating release notes, uploading the notarized app, publishing the release, and merging the pull request. There are no changes to any public APIs or exported entities.

Changes

File	Change Summary
README.md	Added a new "Release" section with 16 enumerated steps guiding the release process: bumping version/build, archiving the product, distributing the app, notarizing, branching, committing, tagging, pushing, drafting GitHub release, generating notes, uploading, publishing, and merging the PR.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Xcode as Xcode
    participant Notary as Notary Service
    participant GH as GitHub

    Dev->>Xcode: Bump version & build number
    Xcode->>Dev: Archive product
    Dev->>Notary: Submit app for notarization
    Notary-->>Dev: Confirm notarization
    Dev->>GH: Create new branch & commit changes
    Dev->>GH: Tag the release and push changes
    GH->>Dev: Draft release and generate notes
    Dev->>GH: Upload notarized app & publish release
    GH->>Dev: Merge pull request

Loading

Poem

I'm a rabbit with hops so bright,
Celebrating release steps done just right.
In the docs, each step does gleam,
Guiding your path like a dream.
With code carrots and joyful cheer,
I hop along to a smooth new year!

---

📜 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 3df8f86 and 91bc998.

📒 Files selected for processing (1)

• README.md (1 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this 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.