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

Fix devcontainer issues for local and Codespaces run #45

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

jamesmcroft
Copy link
Collaborator

Purpose

To resolve #35

This pull request includes several changes to the dev container setup, script configurations, and documentation to improve the development environment and user experience. The most important changes are grouped into three themes: dev container configuration, script updates, and documentation enhancements.

Dev Container Configuration:

  • Updated the Docker image reference in .devcontainer/devcontainer.json to use the vscode namespace.
  • Added remoteUser, containerUser, and port forwarding settings to .devcontainer/devcontainer.json.

Script Updates:

  • Modified .devcontainer/local-features/dev-tools/install.sh to set the USERNAME variable. [1] [2]
  • Added a check to create the .env file if it does not exist in Setup-Environment.ps1.

Documentation Enhancements:

  • Updated the README.md to include new sections for setting up the environment on GitHub Codespaces and locally, and added instructions for deploying the Azure environment. [1] [2] [3] [4]

These changes aim to streamline the development process and provide clearer guidance for setting up and using the development environment.

Does this introduce a breaking change?

[ ] Yes
[x] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[x] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[ ] Other... Please describe:

Other Information

@jamesmcroft jamesmcroft requested a review from Copilot December 19, 2024 14:31

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 2 out of 6 changed files in this pull request and generated no comments.

Files not reviewed (4)
  • .devcontainer/devcontainer.json: Language not supported
  • .devcontainer/local-features/dev-tools/install.sh: Language not supported
  • .gitattributes: Language not supported
  • Setup-Environment.ps1: Language not supported
Comments suppressed due to low confidence (4)

README.md:55

  • The syntax [!IMPORTANT] is not standard Markdown and may not render correctly. Consider using a standard Markdown blockquote or heading for important notes.
> [!IMPORTANT]

README.md:76

  • The syntax [!NOTE] is not standard Markdown and may not render correctly. Consider using a standard Markdown blockquote or heading for notes.
> [!NOTE]

README.md:89

  • The syntax [!NOTE] is not standard Markdown and may not render correctly. Consider using a standard Markdown blockquote or heading for notes.
> [!NOTE]

README.md:98

  • The syntax [!NOTE] is not standard Markdown and may not render correctly. Consider using a standard Markdown blockquote or heading for notes.
> [!NOTE]
@jamesmcroft jamesmcroft changed the title Dev container Fix devcontainer issues for local and Codespaces run Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dev Container does not run
1 participant