Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

fix: update dev container naming (#989)

Jakub Dobryf593bb7004df
diff --git a/.changeset/swift-flowers-approve.md b/.changeset/swift-flowers-approve.md
new file mode 100644
index 000000000..b682b4fd9
--- /dev/null
+++ b/.changeset/swift-flowers-approve.md
@@ -0,0 +1,6 @@
+---
+'@e2b/python-sdk': patch
+'e2b': patch
+---
+
+rename DevContainer methods capitalization and move them to beta
diff --git a/packages/js-sdk/src/template/index.ts b/packages/js-sdk/src/template/index.ts
index bc6704a72..842c9745f 100644
--- a/packages/js-sdk/src/template/index.ts
+++ b/packages/js-sdk/src/template/index.ts
@@ -572,7 +572,7 @@ export class TemplateBase
return this
}
- devcontainerPrebuild(devcontainerDirectory: string): TemplateBuilder {
+ betaDevContainerPrebuild(devcontainerDirectory: string): TemplateBuilder {
if (this.baseTemplate !== 'devcontainer') {
throw new BuildError(
'Devcontainers can only used in the devcontainer template',
@@ -588,7 +588,7 @@ export class TemplateBase
})
}
- setDevcontainerStart(devcontainerDirectory: string): TemplateFinal {
+ betaSetDevContainerStart(devcontainerDirectory: string): TemplateFinal {
if (this.baseTemplate !== 'devcontainer') {
throw new BuildError(
'Devcontainers can only used in the devcontainer template',
diff --git a/packages/js-sdk/src/template/types.ts b/packages/js-sdk/src/template/types.ts
index 4e0b8d388..621a56ec0 100644
--- a/packages/js-sdk/src/template/types.ts
+++ b/packages/js-sdk/src/template/types.ts
@@ -599,10 +599,10 @@ export interface TemplateBuilder {
* ```ts
* template
* .gitClone('https://myrepo.com/project.git', '/my-devcontainer')
- * .devcontainerPrebuild('/my-devcontainer')
+ * .betaDevContainerPrebuild('/my-devcontainer')
* ```
*/
- devcontainerPrebuild(devcontainerDirectory: string): TemplateBuilder
+ betaDevContainerPrebuild(devcontainerDirectory: string): TemplateBuilder
/**
* Start a devcontainer from the specified directory.
@@ -617,12 +617,12 @@ export interface TemplateBuilder {
* // Prebuild and start
* template
* .gitClone('https://myrepo.com/project.git', '/my-devcontainer')
- * .devcontainerPrebuild('/my-devcontainer')
+ * .betaDevContainerPrebuild('/my-devcontainer')
* // Other instructions...
- * .setDevcontainerStart('/my-devcontainer')
+ * .betaSetDevContainerStart('/my-devcontainer')
* ```
*/
- setDevcontainerStart(devcontainerDirectory: string): TemplateFinal
+ betaSetDevContainerStart(devcontainerDirectory: string): TemplateFinal
}
/**
diff --git a/packages/js-sdk/tests/template/stacktrace.test.ts b/packages/js-sdk/tests/template/stacktrace.test.ts
index 895a8d851..a2da070ce 100644
--- a/packages/js-sdk/tests/template/stacktrace.test.ts
+++ b/packages/js-sdk/tests/template/stacktrace.test.ts
@@ -251,26 +251,26 @@ buildTemplateTest('traces on addMcpServer', async () => {
})
buildTemplateTest(
- 'traces on devcontainerPrebuild',
+ 'traces on betaDevContainerPrebuild',
async ({ buildTemplate }) => {
const template = Template()
.fromTemplate('devcontainer')
.skipCache()
- .devcontainerPrebuild(nonExistentPath)
+ .betaDevContainerPrebuild(nonExistentPath)
await expectToThrowAndCheckTrace(async () => {
await buildTemplate(template)
- }, 'devcontainerPrebuild')
+ }, 'betaDevContainerPrebuild')
}
)
buildTemplateTest(
- 'traces on setDevcontainerStart',
+ 'traces on betaSetDevContainerStart',
async ({ buildTemplate }) => {
const template = Template()
.fromTemplate('devcontainer')
- .setDevcontainerStart(nonExistentPath)
+ .betaSetDevContainerStart(nonExistentPath)
await expectToThrowAndCheckTrace(async () => {
await buildTemplate(template)
- }, 'setDevcontainerStart')
+ }, 'betaSetDevContainerStart')
}
)
diff --git a/packages/python-sdk/e2b/template/main.py b/packages/python-sdk/e2b/template/main.py
index 1ddb409be..9648f9845 100644
--- a/packages/python-sdk/e2b/template/main.py
+++ b/packages/python-sdk/e2b/template/main.py
@@ -500,7 +500,7 @@ class TemplateBuilder:
lambda: self.run_cmd(" ".join(args), user=user)
)
- def devcontainer_prebuild(
+ def beta_dev_container_prebuild(
self,
devcontainer_directory: Union[str, Path],
) -> "TemplateBuilder":
@@ -514,7 +514,7 @@ class TemplateBuilder:
Example
```python
template.git_clone('https://myrepo.com/project.git', '/my-devcontainer')
- template.devcontainer_prebuild('/my-devcontainer')
+ template.beta_dev_container_prebuild('/my-devcontainer')
```
"""
if self._template._base_template != "devcontainer":
@@ -538,7 +538,7 @@ class TemplateBuilder:
)
)
- def set_devcontainer_start(
+ def beta_set_dev_container_start(
self,
devcontainer_directory: Union[str, Path],
) -> "TemplateFinal":
@@ -555,12 +555,12 @@ class TemplateBuilder:
```python
# Simple start
template.git_clone('https://myrepo.com/project.git', '/my-devcontainer')
- template.set_start_devcontainer('/my-devcontainer')
+ template.beta_set_devcontainer_start('/my-devcontainer')
# With prebuild
template.git_clone('https://myrepo.com/project.git', '/my-devcontainer')
- template.devcontainer_prebuild('/my-devcontainer')
- template.set_devcontainer_start('/my-devcontainer')
+ template.beta_dev_container_prebuild('/my-devcontainer')
+ template.beta_set_dev_container_start('/my-devcontainer')
```
"""
if self._template._base_template != "devcontainer":
diff --git a/packages/python-sdk/tests/async/template_async/test_stacktrace.py b/packages/python-sdk/tests/async/template_async/test_stacktrace.py
index 6279f00c4..1fd9c0740 100644
--- a/packages/python-sdk/tests/async/template_async/test_stacktrace.py
+++ b/packages/python-sdk/tests/async/template_async/test_stacktrace.py
@@ -220,20 +220,20 @@ async def test_traces_on_add_mcp_server():
@pytest.mark.skip_debug()
-async def test_traces_on_devcontainer_prebuild(async_build):
+async def test_traces_on_dev_container_prebuild(async_build):
template = AsyncTemplate()
template = template.from_template("devcontainer")
- template = template.skip_cache().devcontainer_prebuild(non_existent_path)
+ template = template.skip_cache().beta_dev_container_prebuild(non_existent_path)
await _expect_to_throw_and_check_trace(
- lambda: async_build(template), "devcontainer_prebuild"
+ lambda: async_build(template), "beta_dev_container_prebuild"
)
@pytest.mark.skip_debug()
-async def test_traces_on_set_devcontainer_start(async_build):
+async def test_traces_on_set_dev_container_start(async_build):
template = AsyncTemplate()
template = template.from_template("devcontainer")
- template = template.set_devcontainer_start(non_existent_path)
+ template = template.beta_set_dev_container_start(non_existent_path)
await _expect_to_throw_and_check_trace(
- lambda: async_build(template), "set_devcontainer_start"
+ lambda: async_build(template), "beta_set_dev_container_start"
)
diff --git a/packages/python-sdk/tests/sync/template_sync/test_stacktrace.py b/packages/python-sdk/tests/sync/template_sync/test_stacktrace.py
index 24d5a78b9..7142c1433 100644
--- a/packages/python-sdk/tests/sync/template_sync/test_stacktrace.py
+++ b/packages/python-sdk/tests/sync/template_sync/test_stacktrace.py
@@ -208,16 +208,20 @@ def test_traces_on_add_mcp_server():
@pytest.mark.skip_debug()
-def test_traces_on_devcontainer_prebuild(build):
+def test_traces_on_dev_container_prebuild(build):
template = Template()
template = template.from_template("devcontainer")
- template = template.skip_cache().devcontainer_prebuild(non_existent_path)
- _expect_to_throw_and_check_trace(lambda: build(template), "devcontainer_prebuild")
+ template = template.skip_cache().beta_dev_container_prebuild(non_existent_path)
+ _expect_to_throw_and_check_trace(
+ lambda: build(template), "beta_dev_container_prebuild"
+ )
@pytest.mark.skip_debug()
-def test_traces_on_set_devcontainer_start(build):
+def test_traces_on_set_dev_container_start(build):
template = Template()
template = template.from_template("devcontainer")
- template = template.set_devcontainer_start(non_existent_path)
- _expect_to_throw_and_check_trace(lambda: build(template), "set_devcontainer_start")
+ template = template.beta_set_dev_container_start(non_existent_path)
+ _expect_to_throw_and_check_trace(
+ lambda: build(template), "beta_set_dev_container_start"
+ )