feat: Add dev container

[tschaffter]

Fixes #1059

Changelog

• Add the definition of a dev container that includes Python and Poetry among other tools.
  • See the dev container standard for more information.
  • The dev container image is adapted from the dev container used in https://github.com/Sage-Bionetworks/challenge-registry
  • The dev container includes tools such as Node.js and Java, which should be useful for API/web development and in following PRs I may submit regarding speeding up CI/CD workflow.
• Add the folder tools/ with the script required to build the dev container image sagebionetworks/schematic-devcontainer.
  • See section "Future work" below.
• Define workspace-* commands in dev-env.sh.
  • E.g. workspace-install to install the project dependencies.
• Add a badge to the README to enable developers to start the development environment with VS Code with a single click (click > VS Code starts the dev container > developer is ready to develop).
  • This badge will only work once this PR is merged to the base branch.

Preview

Develop inside the dev container with VS Code

1. Launch VS Code
2. Install the VS Code extension Dev Containers
3. Open the folder of this repository
4. Checkout the branch behind this PR
5. Open the Command Palette (Ctrl+Shift+P)
6. Type "dev" > select "Dev Containers: Open Folder in Container..." > OK
7. You are now inside the dev container with all the tools required to contribute to this project.
   • Try python --version and poetry --version

Develop inside a GitHub Codespace

GitHub Codespace is a new feature that was released in November 2022. It relies on the dev container standard to spin up a development environment for projects that include a dev container definition. You can try starting a GH Codespace using the branch behind this PR.

1. Go to https://github.com/tschaffter/schematic/tree/add-devcontainer
2. Click on the Code button
3. Click on the tab "Codespaces"
4. Click on the button "Create codespace on add-devcontainer" (add-devcontainer is the name of the branch).
5. You are now inside the codespace

Future Work

• Build and publish the dev container image with a GitHub workflow.
• Update CI/CD workflows to perform operations inside the dev container.

[tschaffter]

This PR does not change the code of schematic so I'm not sure why the tests are failing.

[milen-sage]

@tschaffter I think tests fail because the request is from a different fork. I wouldn't worry about that, unless you'd like to :)

[milen-sage]

Just to confirm, @tschaffter the goal of this request - in addition to the various other features of the dev container - is to speed up CI/CD actions?

[milen-sage]

@GiaJordan could you review this PR? I think we can evaluate it and merge it next year (i.e. not urgent for the holidays :)

[tschaffter]

the goal of this request - in addition to the various other features of the dev container - is to speed up CI/CD actions?

@milen-sage Yes, among other benefits to your team.

[tschaffter]

Following a discussion with Milen, I should have the chance to present to the FAIR Data team the benefits of developing inside a dev container early next year.

[thomasyu888]

This could be a good retrospective topic to implement this as a practice when developing