Skip to content

docs(readme): add generic install paths and devcontainer guidance#54

Merged
aymenfurter merged 5 commits into
microsoft:mainfrom
mconstantinescu:chore/devcontainer-and-install-paths
May 27, 2026
Merged

docs(readme): add generic install paths and devcontainer guidance#54
aymenfurter merged 5 commits into
microsoft:mainfrom
mconstantinescu:chore/devcontainer-and-install-paths

Conversation

@mconstantinescu
Copy link
Copy Markdown
Contributor

@mconstantinescu mconstantinescu commented May 25, 2026

Description

Add a Podman-friendly devcontainer and update README installation docs to support three paths:

  • Prebuilt VSIX
  • Dev Container build (no local Node.js/npm)
  • Local Node.js/npm build

Also documents fallback workflow when release publishing permissions are missing.

Related Issues

Relates to install path portability and contributor onboarding improvements.

Checklist

  • npm run check passes (typecheck + lint + spellcheck + knip + tests)
  • Changes are covered by tests (if applicable)
  • Documentation updated (if applicable)

@mconstantinescu mconstantinescu force-pushed the chore/devcontainer-and-install-paths branch from 3e65449 to c37226d Compare May 25, 2026 08:28
@macko76
Copy link
Copy Markdown
Contributor

macko76 commented May 25, 2026

@mconstantinescu please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree

@mconstantinescu mconstantinescu force-pushed the chore/devcontainer-and-install-paths branch 2 times, most recently from 64742d5 to 428081b Compare May 25, 2026 08:41
@mconstantinescu
Copy link
Copy Markdown
Contributor Author

@mconstantinescu please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree

Copy link
Copy Markdown
Contributor

@macko76 macko76 left a comment

Choose a reason for hiding this comment

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

lint and reformatted markdown

Copy link
Copy Markdown
Contributor

@macko76 macko76 left a comment

Choose a reason for hiding this comment

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

Install procedures and prerequisites updated to reflect submission

Copy link
Copy Markdown
Contributor

@macko76 macko76 left a comment

Choose a reason for hiding this comment

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

functionality tested across OS (MacOs / Windows) and Container tooling (Docker or Podman)

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves contributor onboarding and installation portability by documenting multiple install workflows in the root README and introducing a Dev Container setup intended to work with Docker/Podman.

Changes:

  • Updates README.md to describe three installation paths (prebuilt VSIX, Dev Container build, local build) and a fallback workflow when Release publishing permissions are missing.
  • Adds a .devcontainer configuration (Dockerfile + devcontainer.json) for containerized development.
Show a summary per file
File Description
README.md Replaces “Quick Start” with a multi-path installation guide and improves table formatting.
.devcontainer/Dockerfile Introduces a devcontainer image build and attempts to preinstall Playwright dependencies.
.devcontainer/devcontainer.json Adds Dev Containers configuration with recommended extensions and postCreateCommand.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 3/3 changed files
  • Comments generated: 1

Comment thread .devcontainer/Dockerfile Outdated
Comment thread .devcontainer/Dockerfile Outdated
@macko76
Copy link
Copy Markdown
Contributor

macko76 commented May 26, 2026

Addressed remaining Dockerfile feedback on this PR:\n\n- Switched base image to mcr.microsoft.com/devcontainers/typescript-node:22-bookworm\n- Kept Playwright setup on pinned CLI with install-deps only for reproducibility\n\nLatest commit: 3ff3db2 (signed/verified).\n\nPlease re-review when convenient.

@mconstantinescu mconstantinescu force-pushed the chore/devcontainer-and-install-paths branch from 3ff3db2 to 5810b43 Compare May 26, 2026 06:35
@macko76
Copy link
Copy Markdown
Contributor

macko76 commented May 26, 2026

Update on #54:\n\n- Rebased branch on latest main to remove merge conflicts\n- Updated devcontainer base image to mcr.microsoft.com/devcontainers/typescript-node:22-bookworm\n- Kept Playwright setup pinned/reproducible (
px -y playwright@1.60.0 install-deps)\n- All commits on this PR are now signed and verified\n\nCould you please take another look when you have a moment?

Copy link
Copy Markdown
Contributor

@macko76 macko76 left a comment

Choose a reason for hiding this comment

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

comments addressed.

@aymenfurter aymenfurter merged commit 91125bb into microsoft:main May 27, 2026
5 checks passed
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.

4 participants