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

Resolves: Add GitHub Codespaces configuration #608

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from

Conversation

aleks-ivanov
Copy link
Contributor

@aleks-ivanov aleks-ivanov commented Jun 21, 2021

1. GitHub Codespaces:

  • ready-to-start GitHub Codespaces configuration with all necessary tooling

  • in addition, it provides basic tools for:

    • .NET development
    • GitHub support
    • overall more pleasant VS Code experience

The configuration consists of:

  • "settings": - a list of VS Code settings to be applied automatically after the Codespace container is created (.editorconfig overrides these)

    • "workbench.colorTheme": "Default Dark+" - sets the theme of the VS Code workbench to the Default Dark+ theme
    • "terminal.integrated.defaultProfile.linux": "pwsh" - sets the default VS Code terminal to PowerShell Core
  • extensions: - a list of VS Code extensions that are automatically installed after the Codespace container is created

    • "eamodio.gitlens" - provides git information directly inside the code
    • "ms-dotnettools.csharp" and "VisualStudioExptTeam.vscodeintellicode" - provide basic Visual Studio tooling
    • "ms-vscode.powershell" - provides the functionality of Windows PowerShell ISE inside VS Code
    • "cschleiden.vscode-github-actions" and "redhat.vscode-yaml" - provide YAML and GitHub Actions support
    • "bierner.markdown-preview-github-styles" and "ban.spellright" - provide assistance with writing Markdown documentation
    • "jmrog.vscode-nuget-package-manager" - provides use of the NuGet library through the Command Palette
    • "coenraads.bracket-pair-colorizer" - sets different colors for each nested pair of brackets
    • "vscode-icons-team.vscode-icons" - provides a huge set of icons for the VS Code explorer
    • "editorconfig.editorconfig" - attempts to override user/workspace settings with those in the .editorconfig
  • "postCreateCommand" - is a string of commands separated by && that execute after the container has been built and the source code has been cloned. In this configuration, the solution is restored.

  • "build" - declares the Docker configuration that the container would use to run.

  • Dockerfile:

    • "mcr.microsoft.com/vscode/devcontainers/dotnet:0.201.7-5.0" - the Codespace container runs from an Ubuntu 20.04 image with .NET Core SDK installed (0.201.7 is the latest .NET Core SDK Docker image tagged version)
    • Additional installed tools:
      • Mono

This GitHub Codespace configuration can also be used locally with the Remote - Containers extension for VS Code. It automatically creates and runs a Docker container based on the devcontainer.json configuration inside the repo, so anyone could work on the project from any computer, without the need to install anything other than VS Code and Docker.

2. Files changes:

Added Include="Microsoft.TestPlatform.ObjectModel" Version="15.0.0" to Microsoft.OpenApi.Readers.Tests.csproj and Microsoft.OpenApi.Tests.csproj, because when trying to run them, an error that this dependency is missing was preventing the tests from being executed.

Resolves #607

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.

Add GitHub Codespaces configuration
1 participant