🚀 release: v1.0.0-beta.3

[warengonzaga]

Summary by CodeRabbit

• New Features

  • Added a new environment configuration file to support Railway deployment.

• Documentation

  • Updated the README to highlight Railway as the primary one-click deployment option, reorganized deployment instructions, and corrected the Railway template link.
  • Improved documentation for environment variables to clarify requirements.

• Chores

  • Updated .gitignore to allow tracking of Railway-specific environment files.
  • Bumped version to 1.0.0-beta.3.

[Copilot]

Pull Request Overview

This PR updates environment documentation, introduces a Railway one-click deploy option, and adds a Railway-specific sample .env file.

• Clarify that UNTHREAD_WEBHOOK_SECRET is required for full integration
• Add Railway deployment option and reorganize deployment instructions in README.md
• Provide a .env.railway template for Railway deployments

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.

File	Description
src/config/env.ts	Updated comment to mark UNTHREAD_WEBHOOK_SECRET as required
README.md	Added Railway one-click deploy badge, renamed Docker and manual options, and consolidated deploy instructions
.env.railway	Added sample environment variables for Railway deployments

Comments suppressed due to low confidence (1)

README.md:116

• [nitpick] The Railway deploy instructions are duplicated: there's already an Option A badge above. Consider removing this redundant section or consolidating it under the main deployment options.

## 🚂 One-Click Deploy

[coderabbitai]

📝 Walkthrough

Walkthrough

Sir, the update introduces a new .env.railway configuration file tailored for Railway deployments, amends the .gitignore to accommodate this file, and reorganizes the README to prioritize Railway's one-click deploy as the primary installation method. Additionally, a documentation comment in the configuration code is clarified, and the package version is incremented.

Changes

Files/Group	Change Summary
.env.railway	Introduced a new environment configuration file with variables for Railway deployment and integrations.
.gitignore	Updated comments and exceptions to include .env.railway and broaden template file exceptions.
README.md	Reorganized instructions to highlight Railway one-click deploy, adjusted deployment options, and links.
src/config/env.ts	Clarified the documentation comment for UNTHREAD_WEBHOOK_SECRET regarding its necessity for integration.
package.json	Updated version from "1.0.0-beta.2" to "1.0.0-beta.3" without other changes.

Possibly related PRs

• 🚀 release: v1.0.0-beta.1 #21: Prior version bump from "1.0.0-beta.1" to "1.0.0-beta.2," continuing the version update sequence seen in this PR.

---

📜 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 4bb7e94 and 9b5cac9.

📒 Files selected for processing (1)

• package.json (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• package.json

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Build Development Images

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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 or @coderabbitai auto title 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.

[warengonzaga]

@copilot bump the version to v1.0.0-beta.3

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

116-124: Consolidate duplicate deploy sections.
The "One-Click Deploy" section largely duplicates the Railway instructions already in Quick Start. Consider merging or removing redundancy to streamline the user experience.

---

256-256: Reposition deployment call in Sponsors section.
The “Deploy using the [Railway Template]” bullet under Sponsors may confuse readers. It would fit more naturally in Quick Start or the One-Click Deploy section.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c4c8cba and 4bb7e94.

📒 Files selected for processing (4)

• .env.railway (1 hunks)
• .gitignore (1 hunks)
• README.md (4 hunks)
• src/config/env.ts (1 hunks)

🧰 Additional context used

🪛 dotenv-linter (3.3.0)

.env.railway

[warning] 1-1: [SubstitutionKey] The PLATFORM_REDIS_URL key is not assigned properly

---

[warning] 1-1: [ValueWithoutQuotes] This value needs to be surrounded in quotes

---

[warning] 3-3: [SubstitutionKey] The POSTGRES_USER key is not assigned properly

---

[warning] 3-3: [ValueWithoutQuotes] This value needs to be surrounded in quotes

---

[warning] 5-5: [UnorderedKey] The NODE_ENV key should go before the PLATFORM_REDIS_URL key

---

[warning] 5-5: [ValueWithoutQuotes] This value needs to be surrounded in quotes

---

[warning] 7-7: [UnorderedKey] The DATABASE_SSL_VALIDATE key should go before the NODE_ENV key

---

[warning] 7-7: [ValueWithoutQuotes] This value needs to be surrounded in quotes

---

[warning] 9-9: [ValueWithoutQuotes] This value needs to be surrounded in quotes

---

[warning] 11-11: [ValueWithoutQuotes] This value needs to be surrounded in quotes

---

[warning] 13-13: [UnorderedKey] The COMPANY_NAME key should go before the DATABASE_SSL_VALIDATE key

---

[warning] 13-13: [ValueWithoutQuotes] This value needs to be surrounded in quotes

🔇 Additional comments (4)

src/config/env.ts (1)

11-11: Environment variable comment clarification approved.
The added note emphasizes that UNTHREAD_WEBHOOK_SECRET is required for full integration and aligns perfectly with the new .env.railway template.

.gitignore (1)

6-9: Permit .env.railway in ignore exceptions.
The updated pattern ignores all .env* but un-ignores .env.example and .env.railway, matching the new Railway deployment workflow.

README.md (1)

80-85: Verify Railway deploy URL in Quick Start section.
The link https://railway.com/deploy/unthread-telegram-bo?referralCode=dTwT-i looks like it’s missing the trailing “t” in “bot.” Please confirm and correct this template URL to ensure one-click deploy functions as intended.

Also applies to: 97-97

.env.railway (1)

1-14: Template .env.railway file structure approved.
All required and optional variables are defined with placeholders for sensitive data, and the auto-configured Railway variables align with validateEnvironment expectations in src/config/env.ts.