Troubleshooting and best practices - davidgb8246/RapidRollout GitHub Wiki

πŸ›  Troubleshooting and Best Practices

This section outlines common pitfalls, necessary configurations, and best practices to ensure smooth operation with RapidRollout.

πŸ” Project Creation Rules

  • A repository URL can only be used once per user.

    • If you attempt to create another project with the same URL, the system will reject it.
    • If you need to update the project, use the Edit function from the My Projects page instead of creating a new one.

πŸ”” Webhook Requirement

RapidRollout relies entirely on GitHub webhooks to function. Your project will not deploy unless this is properly configured.

  • After creating a project, you must:

    1. Copy the secret token provided in the final step.

    2. Set up a GitHub webhook with:

      • Payload URL from RapidRollout.
      • Content-Type: application/json
      • Events: βœ… Send me everything
      • Secret: Paste the secret token provided.

  • Without the webhook:

    • Initial setup will not complete (awaiting the ping event).
    • Pushes will not trigger deployments.

➑️ Refer to Setting Up Repository Webhooks for detailed instructions.

πŸ“‚ Private Files Must Be Set Before Pushes

Before pushing any code changes, make sure all necessary private files are configured, such as:

  • .env files
  • Secrets
  • Configuration files (.json, .yaml, etc.)
  • Deployment workflow scripts (e.g., after-start bash files)

⚠️ If your app depends on private files and they’re not properly configured:

  • Deployments will fail or result in a non-functional application.
  • Your containers or services may crash due to missing environment variables or configs.

πŸ’‘ Best Practices

  • βœ… Always test your configuration with a manual resave or rebuild before pushing code.
  • βœ… Make sure your After Start Scripts do not rely on interactive input and handle failures gracefully.
  • βœ… Keep your private SSH key safe and regenerate it if compromised.
  • βœ… Use descriptive filenames and folder structures when managing private files to avoid confusion.
  • βœ… Use deployment logs and addDeploymentStatusMessage endpoint to debug scripts and issues.

Still having trouble? Visit the My Projects β†’ Edit view to check deployment logs and status messages for clues.