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

Automate 'Edge Development mode with No Docker' #262

Merged
merged 14 commits into from
Jul 12, 2023
Merged

Conversation

robearlam
Copy link
Member

This PR automates the ability to configure this repository to run 'Edge Development mode with No Docker'. It adds a new param to init.ps1 which will configure the heads, they can the be manually run directly on the host machine.

The README has been updated to include steps required.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have read the Contributing guide.
  • My code/comments/docs fully adhere to the Code of Conduct.
  • My change is a code change.
  • My change is a documentation change and there are NO other updates required.

Closes #178

@robearlam robearlam marked this pull request as ready for review May 29, 2023 04:34
Copy link
Contributor

@jst-cyr jst-cyr left a comment

Choose a reason for hiding this comment

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

I have made some minor spelling corrections. Some things I noticed:

  • In the prerequisites it states a requirement for Docker, but this branch introduces the option for running without Docker. Should we update the language of that Prerequisites section?

  • Does the user need to do the .env initialization of the repo if you are running in Edge mode? The initial sections seem to require me to setup a full .env file, and a lot of that seems like optional stuff for my scenario of just wanting to run the head locally?

  • In the Initializing the repository section, it lists the new EdgeNoDocker environment variable but I don't see that in the .env.template? The instructions should also state what the accepted values are (TRUE/FALSE, YES/NO, 1/0). Is it even needed in the ENV if it's only used as a CLI param to the init script?

  • In the instructions for running the init.ps1 I noticed an inconsistency in variables. -Edge_Token and -EdgeNoDocker. One has an underscore (_) and one does not. I think the new setting should be -Edge_NoDocker, perhaps?

  • Upon trying to execute the init script, I received a warning that I was not in administrator mode for PowerShell. This was obvious, once I thought about it, but before they run the init command we may want a 'warning' ⚠ to remind folks to get into Admin mode.

  • When running npm i on SUGCON EU folder, I got a warning that subscriptions-transport-ws is deprecated and should be replaced with graphql-ws.

  • When trying to run the SUGCON site on localhost:3000, I got an ERR_INVALID_URL. I'm guessing there is some sort of configuration I need to do in the ENV or on the init command, but no way for me to figure out what went wrong here.

@robearlam
Copy link
Member Author

Ok, I think i've got this improved now, addressing each of your points above in order....

  • Updated Readme prerequisites to callout docker not required when not running with docker

  • Init needs to happen to combine set values in the repo, with variable set by init.ps1. This combined list is then used to populate the different env and settings files. It's simpler to do it this way.

  • Edge_NoDocker isn't an ENV var so not present in the .env.template file. Its a variable used to configure how the env is populated. There is no value for it, its a PS Switch variable.

  • Updated variable naming to include underscore.

  • The Script already has a check to ensure the user is running in 'admin mode' I also added something to readme so that the users know this before running the script.

  • This issue isn't related to this PR, lets open a new issue to investigate.

  • I think I had some of the logic wrong in the init.ps1, this should be fixed now.

Copy link
Contributor

@jst-cyr jst-cyr left a comment

Choose a reason for hiding this comment

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

Looks good!

@jst-cyr jst-cyr merged commit 20513f3 into main Jul 12, 2023
@jst-cyr jst-cyr deleted the 178-automate-edge-mode branch July 12, 2023 11:47
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.

Automate the ability to run in Edge mode without Docker
2 participants