Skip to content

Update dstack-proxy contributing guide #2683

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

Merged
merged 2 commits into from
May 30, 2025

Conversation

jvstme
Copy link
Collaborator

@jvstme jvstme commented May 22, 2025

Closes #2252

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@jvstme jvstme requested a review from r4victor May 22, 2025 14:20
ssh -i /path/to/the/gateway/key ubuntu@gateway.example
```

1. Prepare an environment with your development branch on the gateway:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wish the recommended approach wouldn't involve pushing changes to a remote branch. Previously, the guide suggested ssh/scp. Not ideal, but do you think this one is better?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The previous guide suggested building and uploading a wheel. I think running from source is preferable, as it allows to iterate faster, run a debugger, and possibly edit the code on the gateway.

I've tried using rsync to upload the source code, but it's difficult to set up to upload a correct copy of the repo without uploading unnecessary files, like the local venv, and without deleting the necessary remote files, like the remote venv.

But I can include an example on how to push the code via git without the GitHub repo.

Also drop the dependency on `build`, since the
guide no longer suggests building wheels
@jvstme jvstme merged commit 1e16fe1 into master May 30, 2025
73 of 75 checks passed
@jvstme jvstme deleted the issue_2252_proxy_contributing_guide branch May 30, 2025 09:25
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.

Update the gateway contributing guide
2 participants