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

Add devcontainer #1571

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

Add devcontainer #1571

wants to merge 17 commits into from

Conversation

twsl
Copy link

@twsl twsl commented Feb 20, 2025

Changes

In order to supply a standardized development environment for further development, I decided to add a devcontainer.
This also updates yarn to the latest stable version, as the mentioned yarn version was released almost exactly 3 years ago.

Fix #1572

Tests

Tested manually

@twsl
Copy link
Author

twsl commented Feb 20, 2025

I would also exclude the .yarn folder from being committed to git, but I am unsure, if there is a legit reason to keep it

@ilia-db
Copy link
Contributor

ilia-db commented Feb 24, 2025

Hi, thanks for that! But can you provide a bit more rationale of why this is useful in our repo? E.g is this only to improve the development of the extension itself? (also, can we not update yarn version in this same PR, I'd rather do it separately)

@twsl
Copy link
Author

twsl commented Feb 25, 2025

Hi, thanks for that! But can you provide a bit more rationale of why this is useful in our repo? E.g is this only to improve the development of the extension itself? (also, can we not update yarn version in this same PR, I'd rather do it separately)

yes, this only supports and improves the development of the extension itself by providing every developer who wants to contribute with the same docker-based, reproducible environment without the hassle of following any required setup instructions like an using and old yarn version.
I'll revert the yarn changes and can provide a separate pr for that after this one is merged

Copy link
Contributor

@ilia-db ilia-db left a comment

Choose a reason for hiding this comment

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

Sorry for slow review, left a few of comments.

I'm still figuring out the contribution process - Databricks license is not a standard open source one, and we require all contributors to sign a Contributor License Agreement. I'll let you know how to do that soon.

spec: "@yarnpkg/plugin-interactive-tools"
- path: .yarn/plugins/@yarnpkg/plugin-version.cjs
spec: "@yarnpkg/plugin-version"
- path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's revert changes here too? Also in the package.json and yarn.lock files

Copy link
Author

@twsl twsl Mar 4, 2025

Choose a reason for hiding this comment

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

The file is formatted according to prettier, so I'd argue, that it should stay this way.
The changes in package.json and yarn.lock are produced by the defined yarn version and the specified databricks-sdk version, so I'd also argue, that these are also correct

Copy link
Author

@twsl twsl Mar 4, 2025

Choose a reason for hiding this comment

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

If you want to remove the hash from the packageManager field, please provide, how you would like to install yarn, as this came from corepack

Copy link
Contributor

Choose a reason for hiding this comment

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

We have the setup guide in the readme here: https://github.com/databricks/databricks-vscode?tab=readme-ov-file#getting-started

Installing the yarn (and sdk) that way doesn't result in different sha, I'd prefer to keep it that way, at least in the scope of this PR.

Sorry for being nit picky, I'm just not comfortable with accepting changes that modify dependency versions (and their hashes) without obvious (to me) reasons.

Copy link
Author

Choose a reason for hiding this comment

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

no worries, I'll fix this and setup a different pr for a possible switch to corepack and yarn v4

Copy link
Author

@twsl twsl Mar 6, 2025

Choose a reason for hiding this comment

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

The referenced instructions define v2 while the package.json defined v3.2.1. which one is correct? I assume the later one? but that one cannot be installed via npm

@ilia-db
Copy link
Contributor

ilia-db commented Mar 5, 2025

I've figured out the process: we need to send you our CLA to sign before we can accept this contribution. Can you please provide your name, email address, and job title. If you are ok with that, please send an email with the info to [email protected] email, and we will take it from there.

Copy link
Contributor

github-actions bot commented Mar 6, 2025

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/vscode

Inputs:

  • PR number: 1571
  • Commit SHA: 7bd0da0cc37cd327cdf28422c0508334bb7941ac

Checks will be approved automatically on success.

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 devcontainer
2 participants