Changeset 55303

Timestamp:

02/10/2023 02:59:04 AM (22 months ago)

Author:

helen

Message:

Build/Test Tools: Add a devcontainer for Codespaces support.

This adds a devcontainer configuration tested for use with GitHub Codespaces. It is currently built on top of the Docker wordpress image for initial trial purposes. We should eventually be using our own containers to fully own the environment.

This should be considered a beta run to get a sense of how well cloud dev containers work for core contributors, in particular at contributor day events with limited bandwidth and mobile devices.

Props samruddhikhandale, dinhtungdu, helen, craiglpeters, sam1el, wirecat.
See #57187.

Location:

trunk

Files:

• .devcontainer (added)
• .devcontainer/devcontainer.json (added)
• .devcontainer/docker-compose.yml (added)
• .devcontainer/install-tools.sh (added)
• .devcontainer/setup.sh (added)
• .devcontainer/welcome-message.txt (added)
• .gitignore (modified) (1 diff)
• README.md (modified) (2 diffs)

trunk/.gitignore

@@ -39 +39 @@
 /packagehash.txt
 /artifacts
+/setup.log
 
 # Files and folders that get created in wp-content

trunk/README.md

@@ -7 +7 @@
 
 ## Getting Started
+
+### Using GitHub Codespaces
+
+To get started, create a codespace for this repository by clicking this 👇 
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=trunk&repo=75645659)
+
+A codespace will open in a web-based version of Visual Studio Code. The [dev container](.devcontainer/devcontainer.json) is fully configured with softwares needed for this project.
+
+**Note**: Dev containers is an open spec which is supported by [GitHub Codespaces](https://github.com/codespaces) and [other tools](https://containers.dev/supporting).
+
+In some browsers the keyboard shortcut for opening the command palette (Ctrl/Command + Shift + P) may collide with a browser shortcut. The command palette can be opened via the `F1` key or via the cog icon in the bottom left of the editor.
+
+When opening your codespace, be sure to wait for the `postCreateCommand` to finish running to ensure your WordPress install is successfully set up. This can take a few minutes.
+
+### Local development
 
 WordPress is a PHP, MySQL, and JavaScript based project, and uses Node for its JavaScript dependencies. A local development environment is available to quickly get up and running.
@@ -109 +125 @@
 * Password: `password`
 
+**Note:** With Codespaces, open the portforwarded URL from the ports tab in the terminal, and append `/wp-admin` to login to the site.
+
 To generate a new password (recommended):