Skip to main content

hocus.yml

To configure your project, use the hocus.yml file which should be placed in the root of your project. You can define various settings such as the image for your workspace, prebuild tasks, tasks to run when starting a workspace and the IDE extensions that need to be installed.

It is important to note that the image specified in the hocus.yml file must extend hocusdev/workspace. This image contains all necessary dependencies required by Hocus and is built from this Dockerfile.

Example​

image:
  buildContext: .
  # The Dockerfile MUST extend `hocusdev/workspace`.
  file: hocus.Dockerfile
tasks:
  - name: First task
    prebuild: echo "This executes during the prebuild 👷🏻‍♂️"
    workspace: echo "This executes every time the workspace is started"
  - name: Second task
    prebuild: echo "This also executes during the prebuild 👷🏻‍♂️"
    workspace: python3 hello-world.py
vscode:
  extensions:
    - redhat.vscode-yaml

Schema​

Expand the fields to see their descriptions.

Loading ....