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

Create Devcontainer build #1216

Merged
merged 17 commits into from
Oct 3, 2024
Merged

Create Devcontainer build #1216

merged 17 commits into from
Oct 3, 2024

Conversation

bennothommo
Copy link
Member

@bennothommo bennothommo commented Sep 29, 2024

This PR introduces the ability for Winter to run in a development container, which is basically a pre-constructed configuration for Docker that creates a fully-functional development environment for Winter. It is supported by VSCode, PHPStorm and many other editors to easily create local development copies, and also allows us to use GitHub Codespaces to test PRs or make edits to the core directly in GitHub.

A more thorough explanation can be found in the README for the dev container configuration.

@bennothommo
Copy link
Member Author

Here's how it looks in GitHub Codespaces:

screenshot

@bennothommo bennothommo changed the title [WIP] Create Devcontainer build Create Devcontainer build Sep 30, 2024
@bennothommo bennothommo added needs review Issues/PRs that require a review from a maintainer and removed Status: In Progress labels Sep 30, 2024
@LukeTowers
Copy link
Member

@jaxwilko do you have any input?

@bennothommo does the .devcontainer folder get included when creating winter projects with composer?

@bennothommo
Copy link
Member Author

@LukeTowers currently, yes it would. I'm in two trains of thought on whether to keep it for Composer installs - on the one hand, using Composer would imply they have a working dev environment (or at least PHP). On the other hand, it's still quite useful for getting a project off the ground quickly without having to bootstrap it.

It might be worth stripping it out for installs through the Web Installer though.

@jaxwilko
Copy link
Member

jaxwilko commented Oct 1, 2024

@LukeTowers Looks cool to me, I generally just spin up my own containers and probably wouldn't use the one provided here but I can see the value for some people.

@bennothommo I would lean more to excluding it when installed with composer, generally if somebody has php install then they probably have it set up... or can run the php built-in web server. Perhaps it should only be downloaded when cloning the repo (i.e. not in the web installer or via composer).

@bennothommo
Copy link
Member Author

I'll merge this now as it's a developmental change that won't affect anyone else. We can tweak if we need to, down the line.

@bennothommo bennothommo merged commit 23ce8b0 into develop Oct 3, 2024
11 checks passed
@bennothommo bennothommo deleted the wip/devcontainer branch October 3, 2024 00:03
@LukeTowers LukeTowers removed needs review Issues/PRs that require a review from a maintainer Type: Conceptual Enhancement labels Oct 3, 2024
@LukeTowers LukeTowers added this to the 1.2.7 milestone Oct 3, 2024
@LukeTowers LukeTowers added Status: Completed enhancement PRs that implement a new feature or substantial change labels Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement PRs that implement a new feature or substantial change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants