Cloud-Native Development Button Customization

About 398 wordsAbout 1 min

Customize the appearance and behavior of the cloud-native development launch button to make your project stand out.

Use Cases

Create a unique launch experience for open-source projects
Highlight the development environment features of your project
Control resource configuration of the development environment (e.g., CPU cores)
Disable the default launch button (e.g., when using a custom pipeline instead)

Configuration

Add the workspace configuration to .cnb/settings.yml:

.cnb/settings.yml
# Cloud-native development configuration
# Note: reads the .cnb/settings.yml configuration from the current branch where the cloud-native launch button is located
workspace:
  launch:
    # Customize the cloud-native development launch button
    button:
      # Button name
      name: Launch Cloud-Native Development
      # Button description
      # If the value is null, the default description is not displayed
      description: Click this button to launch the cloud-native development environment
      # Image displayed when hovering over the button
      # 1.Use images from the current branch in the repository, specify the path relative to the repository root directory, e.g., .cnb/launch-hover.gif;
      # 2.Use the raw file address under the current domain name, for example: https://cnb.cool/my/test/-/git/raw/main/launch-hover.gif
      # Image maximum 10MB
      hoverImage: .cnb/launch-hover.gif
    # CPU core number, default is: 8. Only valid for the default template. If there is a custom cloud-native development launch pipeline, this configuration is invalid
    cpus: 4
    # Whether to disable the default button. The default is: false means not disabled. true means disabled
    disabled: false
    # Whether to automatically open the WebIDE after the environment is created. The default is: false
    # When openssh is not installed in the development environment (only supports WebIDE): regardless of the value of this parameter,
    # the WebIDE will be automatically opened after the environment is created
    autoOpenWebIDE: false

Parameter Reference

Parameter	Type	Default	Description
`workspace.launch.button.name`	string	-	The name of the launch button
`workspace.launch.button.description`	string \| null	-	Button description. Set to `null` to hide the default description
`workspace.launch.button.hoverImage`	string	-	Image displayed on hover. Supports repository relative path or raw URL, max 10MB
`workspace.launch.cpus`	number	8	Number of CPU cores. Only effective for the default template
`workspace.launch.disabled`	boolean	false	Whether to disable the default launch button
`workspace.launch.autoOpenWebIDE`	boolean	false	Whether to automatically open WebIDE after the environment is created

Tips

All parameters are optional. Configure only what you need.