vscode-runme
Build the Runme VS Code extension end-to-end.
Installation
dagger install github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4Entrypoint
Return Type
VscodeRunme !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| source | Directory | - | No description provided |
Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
func (m *MyModule) Example() *dagger.VscodeRunme {
return dag.
VscodeRunme()
}@function
def example() -> dagger.VscodeRunme:
return (
dag.vscode_runme()
)@func()
example(): VscodeRunme {
return dag
.vscodeRunme()
}Types
VscodeRunme 🔗
source() 🔗
The source to build the extension from.
Return Type
Directory ! Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
sourcefunc (m *MyModule) Example() *dagger.Directory {
return dag.
VscodeRunme().
Source()
}@function
def example() -> dagger.Directory:
return (
dag.vscode_runme()
.source()
)@func()
example(): Directory {
return dag
.vscodeRunme()
.source()
}container() 🔗
The container to build the extension in.
Return Type
Container ! Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
containerfunc (m *MyModule) Example() *dagger.Container {
return dag.
VscodeRunme().
Container()
}@function
def example() -> dagger.Container:
return (
dag.vscode_runme()
.container()
)@func()
example(): Container {
return dag
.vscodeRunme()
.container()
}presetup() 🔗
The presetup script to be added to the container.
Return Type
File ! Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
presetupfunc (m *MyModule) Example() *dagger.File {
return dag.
VscodeRunme().
Presetup()
}@function
def example() -> dagger.File:
return (
dag.vscode_runme()
.presetup()
)@func()
example(): File {
return dag
.vscodeRunme()
.presetup()
}defaultPlatform() 🔗
Get the default platform for the container.
Return Type
Scalar ! Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
default-platformfunc (m *MyModule) Example() {
return dag.
VscodeRunme().
DefaultPlatform()
}@function
def example() -> :
return (
dag.vscode_runme()
.default_platform()
)@func()
example(): {
return dag
.vscodeRunme()
.defaultPlatform()
}base() 🔗
Sets up the base container
Return Type
VscodeRunme ! Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
basefunc (m *MyModule) Example() *dagger.VscodeRunme {
return dag.
VscodeRunme().
Base()
}@function
def example() -> dagger.VscodeRunme:
return (
dag.vscode_runme()
.base()
)@func()
example(): VscodeRunme {
return dag
.vscodeRunme()
.base()
}build() 🔗
Builds the VSIX extension file.
Return Type
VscodeRunme !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| runmeBinary | Directory ! | - | - The runme binary to be added to the container. |
Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
build --runme-binary DIR_PATHfunc (m *MyModule) Example(runmeBinary *dagger.Directory) *dagger.VscodeRunme {
return dag.
VscodeRunme().
Build(runmeBinary)
}@function
def example(runme_binary: dagger.Directory) -> dagger.VscodeRunme:
return (
dag.vscode_runme()
.build(runme_binary)
)@func()
example(runmeBinary: Directory): VscodeRunme {
return dag
.vscodeRunme()
.build(runmeBinary)
}bundle() 🔗
Bundles the VSIX extension file.
Return Type
File ! Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
bundlefunc (m *MyModule) Example() *dagger.File {
return dag.
VscodeRunme().
Bundle()
}@function
def example() -> dagger.File:
return (
dag.vscode_runme()
.bundle()
)@func()
example(): File {
return dag
.vscodeRunme()
.bundle()
}unitTest() 🔗
Runs the unit tests.
Return Type
Container !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| debug | Boolean ! | false | - Whether to run the tests in debug mode. |
Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
unit-test --debug booleanfunc (m *MyModule) Example(debug bool) *dagger.Container {
return dag.
VscodeRunme().
UnitTest(debug)
}@function
def example(debug: bool) -> dagger.Container:
return (
dag.vscode_runme()
.unit_test(debug)
)@func()
example(debug: boolean): Container {
return dag
.vscodeRunme()
.unitTest(debug)
}integrationTest() 🔗
Integration tests the extension end-to-end.
Return Type
Container !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| runmeTestToken | Secret | - | - The Runme test token to use for integration tests. |
| debug | Boolean ! | false | - Whether to run the tests in debug mode. |
| spec | String | - | - The spec file to run, omit "tests/e2e". |
Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
integration-test --debug booleanfunc (m *MyModule) Example(debug bool) *dagger.Container {
return dag.
VscodeRunme().
IntegrationTest(debug)
}@function
def example(debug: bool) -> dagger.Container:
return (
dag.vscode_runme()
.integration_test(debug)
)@func()
example(debug: boolean): Container {
return dag
.vscodeRunme()
.integrationTest(debug)
}ghaJob() 🔗
Sets the GitHub Actions job info.
Return Type
VscodeRunme !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| actor | String ! | - | - The GitHub Actions actor. |
| baseOwner | String ! | - | - The GitHub Actions base owner. |
| eventName | String ! | - | - The GitHub Actions event name. |
| forkOwner | String ! | - | - The GitHub Actions fork owner. |
Example
dagger -m github.com/runmedev/vscode-runme@56bedb49562a433597665cc178ae06a2466501a4 call \
gha-job --actor string --base-owner string --event-name string --fork-owner stringfunc (m *MyModule) Example(actor string, baseOwner string, eventName string, forkOwner string) *dagger.VscodeRunme {
return dag.
VscodeRunme().
GhaJob(actor, baseOwner, eventName, forkOwner)
}@function
def example(actor: str, base_owner: str, event_name: str, fork_owner: str) -> dagger.VscodeRunme:
return (
dag.vscode_runme()
.gha_job(actor, base_owner, event_name, fork_owner)
)@func()
example(actor: string, baseOwner: string, eventName: string, forkOwner: string): VscodeRunme {
return dag
.vscodeRunme()
.ghaJob(actor, baseOwner, eventName, forkOwner)
}