Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spike(Deployment): Add GitHub Pages Deployment Action #168

Closed
wants to merge 6 commits into from

Conversation

sweep-ai[bot]
Copy link
Contributor

@sweep-ai sweep-ai bot commented Aug 19, 2023

Description

This PR adds a new GitHub action workflow and jobs that are manually triggered to build the React-Typescript client and deploy it to GitHub pages. The goal is to automate the deployment process and make it easier for contributors to deploy the client.

Summary of Changes

  • Added a new file .github/workflows/deploy.yml to define the GitHub action workflow for deployment.
  • Modified the deploy.yml file to include the necessary steps to build the React-Typescript client and deploy it to GitHub pages.
  • Modified the package.json file in the client directory to include a script for building the client.
  • Modified the package.json file in the root directory to include a script for deploying the client to GitHub pages.
  • Modified the README.md file to include instructions for manually triggering the deployment workflow.

Please review and merge this PR to enable automated deployment of the React-Typescript client to GitHub pages.

Fixes #167.


To checkout this PR branch, run the following command in your terminal:

git checkout sweep/github-pages-deployment

To get Sweep to edit this pull request, leave a comment below or in the code. Leaving a comment in the code will only modify the file but commenting below can change the entire PR.

@sweep-ai sweep-ai bot added the sweep Assigns Sweep to an issue or pull request label Aug 19, 2023
@justinthelaw
Copy link
Owner

The README instructions for deployment have modified too many parts of the README and added some odd artifacts. Focus on just the steps somewhere in the local development or contributing sections.

Double check the package.json at the root of the repository and make sure the scripts there are adequate and/or exist for the deployment GitHub action to be used.

@sweep-ai
Copy link
Contributor Author

sweep-ai bot commented Aug 19, 2023

The README instructions for deployment have modified too many parts of the README and added some odd artifacts. Focus on just the steps somewhere in the local development or contributing sections.

Double check the package.json at the root of the repository and make sure the scripts there are adequate and/or exist for the deployment GitHub action to be used.

Hi @justinthelaw,

I decided to make the following changes:

File Path Proposed Changes
.github/workflows/deploy.yml Modify .github/workflows/deploy.yml with contents:
• Remove the unnecessary parts and artifacts from the file.
README.md Modify README.md with contents:
• Remove the modified parts and artifacts related to deployment instructions.
package.json Modify package.json with contents:
• Review the scripts in the package.json file and ensure that they are adequate for the deployment GitHub action to be used. Make any necessary modifications to the scripts.

@justinthelaw justinthelaw deleted the sweep/github-pages-deployment branch August 20, 2023 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sweep Assigns Sweep to an issue or pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Spike(Deployment): GitHub Pages Deployment Action
1 participant