Add Codespaces support #4292
Closed
Add Codespaces support #4292
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds support for GitHub Codespaces. It includes a devcontainer configuration that will be used to create a Codespace for this repository. The configuration includes: - Dockerfile: Installs `ruby:dev-3.2-buster` image. When the version of ruby used by this project changes, the Dockerfile should be updated. An attempt to install the correct version of ruby will be done, but it will take a while to download and compile the version. - devcontainer.json: Specifies the configuration for the Codespace. It includes the Dockerfile to use, the extensions to install, and the settings to use. - docker-compose.yml: Specifies the services to run in the Codespace. It includes the `postgres` service. - post-create.sh: Script that runs after the Codespace is created. It optionally installs a new version of ruby, sets up the database, and prepares the environment.
aeisenberg
commented
Apr 21, 2024
dorner
requested changes
Apr 22, 2024
|
@dorner does this change make sense to you? Now if the |
|
Looks good to me - @awwaiid can you review? |
awwaiid
reviewed
May 10, 2024
| @@ -65,7 +65,16 @@ Thanks for checking us out! If you're new here, here are some things you should | |||
| ### Join us on slack 💬 | |||
| You can sign up [here](https://join.slack.com/t/rubyforgood/shared_invite/zt-21pyz2ab8-H6JgQfGGI0Ab6MfNOZRIQA) and find us in #human-essentials. Many helpful members are available to answer your questions. Just ask, and someone will be there to help you! | |||
|
|
|||
| ## Getting Started 🛠️ | |||
| ## Getting Started (Codespaces) 🛠️ | |||
|
|
|||
There was a problem hiding this comment.
Could you add in this quick-start button for the full 🪄 ?
Suggested change
| [](https://codespaces.new/rubyforgood/human-essentials/tree/main?quickstart=1) | |
|
Ah -- also from testing you need to add
|
cielf
reviewed
May 10, 2024
| @@ -65,7 +65,16 @@ Thanks for checking us out! If you're new here, here are some things you should | |||
| ### Join us on slack 💬 | |||
| You can sign up [here](https://join.slack.com/t/rubyforgood/shared_invite/zt-21pyz2ab8-H6JgQfGGI0Ab6MfNOZRIQA) and find us in #human-essentials. Many helpful members are available to answer your questions. Just ask, and someone will be there to help you! | |||
|
|
|||
| ## Getting Started 🛠️ | |||
| ## Getting Started (Codespaces) 🛠️ | |||
|
|
|||
There was a problem hiding this comment.
Yeah that thought came to my mind too. Let's move it down and change it to ## Getting Started (Codespaces -- EXPERIMENTAL)
|
Closing in favour of #4353. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #3829
Description
This PR adds support for GitHub Codespaces. It includes a devcontainer configuration that will be used to create a Codespace for this repository. The configuration includes:
ruby:dev-3.2-busterimage. When the version of ruby used by this project changes, the Dockerfile should be updated. An attempt to install the correct version of ruby will be done, but it will take a while to download and compile the version.postgresservice.Type of change
This PR adds codespaces support. It is not an externally facing feature. The documentation changes are only for setting up the dev environment. I have included a change to the README to help with this.
How Has This Been Tested?
To test this out, create a new codespace for the project, wait for everything to load, and run
bin/start. The project should start with no errors.