Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 9, 2025

This PR adds detailed deployment documentation to the project README, explaining how the automated deployment process works for the Glowing Telegram Frontend, including both comprehensive setup instructions and advanced version management capabilities.

Changes Made

Added a new "Deployment" section to README.md that covers:

How to Deploy

  • Step-by-step instructions for triggering manual deployments via GitHub Actions
  • Clear explanation of required inputs (release version, environment selection, and rollback version)

Prerequisites

  • Repository environment configuration requirements in GitHub
  • Complete list of all required environment variables with descriptions:
    • AWS configuration (AWS_REGION, AWS_ROLE_ARN, BUCKET_NAME)
    • Authentication setup (COGNITO_CLIENT_ID, COGNITO_USER_POOL_ID, COGNITO_DOMAIN)
    • API endpoints (API_URL, WEBSOCKET_URL, CONTENT_URL)
    • External integrations (TWITCH_CLIENT_ID)
    • Redirect URIs (LOGOUT_URI, REDIRECT_URI)

Deployment Process

  • Detailed workflow explanation covering all steps from code checkout to S3 deployment
  • Node.js setup, dependency installation, building with environment variables, AWS authentication, file sync, and version info creation

Frontend Version Management

  • Advanced version management system with comprehensive config/version.json file
  • Explanation of versioned deployments to separate S3 paths
  • Instant rollback capabilities without redeployment
  • Version metadata including deployment environment and timestamps

Release Versioning

  • Semantic versioning guidelines and examples
  • S3 path structure (s3://bucket-name/release-version/)
  • Benefits of versioned deployments for rollbacks and multiple environment hosting

Local Build Testing

  • Instructions for testing production builds locally before deployment using npm run build and npm run serve

Workflow Enhancements

The PR also includes merged workflow improvements from main:

  • Added rollbackVersion input parameter to publish.yml
  • Added version info creation and upload steps that generate comprehensive deployment metadata
  • Enhanced deployment process with automated version tracking

The documentation is strategically positioned between the Project Structure and Contributing sections, maintaining the README's logical flow while providing essential deployment information for maintainers and contributors.

Fixes #97.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@Copilot Copilot AI assigned Copilot and saebyn Aug 9, 2025
@Copilot Copilot AI changed the title [WIP] document how deploys work in the project README Add comprehensive deployment documentation to README Aug 9, 2025
@Copilot Copilot AI requested a review from saebyn August 9, 2025 18:40
Copilot finished work on behalf of saebyn August 9, 2025 18:40
@saebyn
Copy link
Owner

saebyn commented Aug 9, 2025

@copilot merge the new work on the deploy process into this PR from main

Copy link
Contributor Author

Copilot AI commented Aug 9, 2025

@copilot merge the new work on the deploy process into this PR from main

I've successfully merged the new deployment workflow improvements from main into this PR. The changes include:

• Added rollbackVersion input parameter to the GitHub Actions workflow
• Added version info creation and upload steps that generate a comprehensive config/version.json file
• Updated the README documentation to combine the detailed setup instructions with the new version management capabilities

The merged documentation now provides both comprehensive deployment prerequisites and the advanced version management features. Commit: 17d97ec

All builds and tests pass successfully.

@Copilot Copilot AI changed the title Add comprehensive deployment documentation to README Add comprehensive deployment documentation with advanced version management to README Aug 9, 2025
Copilot finished work on behalf of saebyn August 9, 2025 22:08
@saebyn saebyn marked this pull request as ready for review August 9, 2025 22:12
@Copilot Copilot AI review requested due to automatic review settings August 9, 2025 22:12
@saebyn saebyn enabled auto-merge (rebase) August 9, 2025 22:13
auto-merge was automatically disabled August 9, 2025 22:13

Rebase failed

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds comprehensive deployment documentation to the README.md file, explaining the automated deployment process for the Glowing Telegram Frontend with advanced version management capabilities. The documentation provides step-by-step deployment instructions, prerequisites setup, and detailed explanation of the versioned deployment system.

Key changes include:

  • Added detailed "How to Deploy" section with GitHub Actions workflow instructions
  • Comprehensive prerequisites documentation covering repository environments and required environment variables
  • Enhanced deployment process explanation and version management system documentation

@saebyn saebyn enabled auto-merge (rebase) August 9, 2025 22:20
auto-merge was automatically disabled August 9, 2025 22:21

Rebase failed

Copilot AI and others added 2 commits August 9, 2025 17:07
Co-authored-by: saebyn <185030+saebyn@users.noreply.github.com>
@saebyn saebyn enabled auto-merge (rebase) August 10, 2025 00:09
@saebyn saebyn merged commit dfab3f9 into main Aug 10, 2025
4 checks passed
@saebyn saebyn deleted the copilot/fix-97 branch August 10, 2025 00:10
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.

document how deploys work in the project README

2 participants