quarto-dev / quarto-dev/quarto-cli

[code-links] Support devcontainer.json links to sub folder

Open
#6,717 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement use
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

(Note - we currently detect devcontainers in subfolders, but do not form links to them, instead forming a global devcontainer link and letting GitHub sort it out)

Discussed in https://github.com/quarto-dev/quarto-cli/discussions/6683

Originally posted by eitsupi September 2, 2023

Description

I am excited to see the Repo link feature trying to support Dev Container / GitHub Codespaces. c7803eab16a217cc3fd26a2039db7c090cedd8f0

By the way, note that multiple Dev Container definitions can be included in a single repository.
The Spec says:

  • .devcontainer/devcontainer.json
  • .devcontainer.json
  • .devcontainer/<folder>/devcontainer.json (where is a sub-folder, one level deep)

https://containers.dev/implementors/spec/#devcontainerjson

In fact, we can create demos that include links to multiple Codespaces in a single repository, such as:
https://github.com/eitsupi/devcontainer-try-r

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the code-links entry point that detects devcontainers and currently forms a global link. Compare link generation with the devcontainer.json specification and confirm the expected behavior for one-level subfolders. Done means each supported subfolder definition produces its own repository link, including repositories with multiple Codespaces definitions.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
cli, developer-experience
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.