codespace.Codespace

github_codespace

`github_codespace` is a cloud-hosted development environment running in a real Docker container, reachable from a browser, VS Code, or the GitHub CLI with no local setup at all. Organizations customize the container itself via configuration files, so every codespace for a project starts from the same real, consistent environment.

Example

import { intent, resource, stack } from "@ubx/sdk";
import { Codespace } from "@ubx/sdk-github/codespace";

export default stack("example", () => {
  intent({ summary: "example own codespace" });

  resource(Codespace, "example", {
    codespaceName: "example-codespace-name",
  });
});

package main

import (
	codespace "github.com/ubiquex/ubx-sdk-github/sdk/go/v2/github/codespace"
	ubx "github.com/ubiquex/ubx-sdk-go/runtime"
)

func main() {
	ubx.Main(ubx.Stack("example", func() {
		ubx.Intent(ubx.IntentInfo{Summary: "example own codespace"})

		ubx.Resource(codespace.Codespace, "example", codespace.CodespaceConfig{
			CodespaceName: "example-codespace-name",
		})
	}))
}

import ubx_sdk as ubx
from ubx.github.codespace.codespace import Codespace, CodespaceConfig

def describe():
    ubx.intent("example own codespace")

    ubx.resource(Codespace, "example", CodespaceConfig(
        codespace_name="example-codespace-name",
    ))

if __name__ == "__main__":
    ubx.run("example", describe)

import { intent, resource, stack } from "@ubx/sdk";
import { Codespace } from "@ubx/sdk-github/codespace";

export default stack("example", () => {
  intent({ summary: "example own codespace" });

  resource(Codespace, "example", {
    codespaceName: "example-codespace-name",
  });
});

Input properties

codespace_namestringrequired: path parameter, not part of the API's own resource representation

Output properties

billable_ownerobject: A GitHub user.
created_atstring: The timestamp indicating when the codespace was created. Computed by GitHub after `ship`.
devcontainer_pathstring: Path to devcontainer.json from repo root used to create Codespace.
display_namestring: Display name for this codespace.
environment_idstring: UUID identifying this codespace's environment.
git_statusobject: Details about the codespace's git repository.
idnumber: The real, numeric, globally unique identifier for this object.
idle_timeout_minutesnumber: The number of minutes of inactivity after which this codespace will be automatically stopped.
idle_timeout_noticestring: Text to show user when codespace idle timeout minutes has been overriden by an organization policy
last_known_stop_noticestring: The text to display to a user when a codespace has been stopped for a potentially actionable reason.
last_used_atstring: Last known time this codespace was started.
locationstring: The initally assigned location of a new codespace.
machineobject: A description of the machine powering a codespace.
machines_urlstring: API URL to access available alternate machine types for this codespace.
namestring: Automatically generated name of this codespace.
ownerobject: A GitHub user.
pending_operationbool: Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.
pending_operation_disabled_reasonstring: Text to show user when codespace is disabled by a pending operation
prebuildbool: Whether the codespace was created from a prebuild.
publish_urlstring: API URL to publish this codespace to a new repository.
pulls_urlstring: API URL for the Pull Request associated with this codespace, if any.
recent_folderslist(string): List of recently opened folders in the Codespace, showing the paths of folders the user has accessed recently. Computed by GitHub after `ship`.
repositoryobject: Minimal Repository
retention_expires_atstring: When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"
retention_period_minutesnumber: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
runtime_constraintsobject: Constraints applied to the codespace's runtime environment, such as allowed port privacy settings. Computed by GitHub after `ship`.
start_urlstring: API URL to start this codespace.
statestring: State of this codespace.
stop_urlstring: API URL to stop this codespace.
updated_atstring: The timestamp of the last update to the codespace, in ISO 8601 format. Computed by GitHub after `ship`.
urlstring: API URL for this codespace.
web_urlstring: URL to access this codespace on the web.