Dev Container Integration.

[huxuan]

TODO:

• Multi-stage (prod and dev) Dockerfile (chore: Add devcontainer prebuild with GitHub Actions and GitLab CI/CD. #263)
  • https://github.com/orgs/devcontainers/discussions/4#discussioncomment-4152158
  • Document best practice for multi-stage dockerfiles for dev, build, and prod microsoft/vscode-dev-containers#304 (comment)
  • https://pdm-project.org/latest/usage/advanced/#use-pdm-in-a-multi-stage-dockerfile
• Pre-build images with GitHub Actions (chore: Add devcontainer prebuild with GitHub Actions and GitLab CI/CD. #263)
  • https://containers.dev/guide/prebuild
• Pre-build images with GitLab CI/CD (chore: Add devcontainer prebuild with GitHub Actions and GitLab CI/CD. #263)
  • https://containers.dev/guide/gitlab-ci
• Dev Container configuration with pre-build image (chore: Add devcontainer configuration. #281)
  • https://containers.dev/guide/dockerfile
• Dev Container badge (docs: Add devcontainer related badges in README. #282)
  • https://code.visualstudio.com/docs/devcontainers/create-dev-container#_add-an-open-in-dev-container-badge
  • DevContainer Workflow badge.
• Improve performance for .venv folder (chore: Add devcontainer configuration. #281)
  • https://code.visualstudio.com/remote/advancedcontainers/improve-performance
• make dev as Post start command (chore: Add devcontainer configuration. #281)
  • https://code.visualstudio.com/remote/advancedcontainers/start-processes
• Dev Container Environemnt Variables Injection #280
  • https://code.visualstudio.com/remote/advancedcontainers/environment-variables
• Config VSCode Extensions. (chore: Add devcontainer configuration. #281)
  • https://containers.dev/supporting#visual-studio-code
• Trigger image built workflow only when changes happened in the prebuild devcontainer folder. (chore: Add devcontainer prebuild with GitHub Actions and GitLab CI/CD. #263, chore: Add devcontainer configuration. #281)
  • Done for GitHub, depends on Use rules instead of only in GitLab CI/CD. #264 for GitLab.
• Build prod image when release. #277
• Container Registry host adapted to GitHub and GitLab. (chore: Adaptive container registry host. #290)
• Support manually trigger of devcontainer prebuild. (chore: Support manually trigger for GitHub devcontainer workflow. #286)
• Documentation. (doc: Add Dev Containers related documentation. #305)

Dependencies:

• The official DevContainer GitHub Actions lacks of build-args: Support for Docker build arguments devcontainers/ci#270

NOTES:

• No use for features and templates, try to be as general as possible, considering the scenarios that dev containers is not used but a dev/prod container image is still needed.

References:

• https://code.visualstudio.com/docs/devcontainers/containers
• https://containers.dev/

[huxuan]

Closed as most of the tasks are done and those remaining (with external dependency) are tracked with separate issues.