| 1 | ## Learn more about this file at 'https://www.gitpod.io/docs/references/gitpod-yml'
|
| 2 | ##
|
| 3 | ## This '.gitpod.yml' file when placed at the root of a project instructs
|
| 4 | ## Gitpod how to prepare & build the project, start development environments
|
| 5 | ## and configure continuous prebuilds. Prebuilds when enabled builds a project
|
| 6 | ## like a CI server so you can start coding right away - no more waiting for
|
| 7 | ## dependencies to download and builds to finish when reviewing pull-requests
|
| 8 | ## or hacking on something new.
|
| 9 | ##
|
| 10 | ## With Gitpod you can develop software from any device (even iPads) via
|
| 11 | ## desktop or browser based versions of VS Code or any JetBrains IDE and
|
| 12 | ## customise it to your individual needs - from themes to extensions, you
|
| 13 | ## have full control.
|
| 14 | ##
|
| 15 | ## The easiest way to try out Gitpod is install the browser extenion:
|
| 16 | ## 'https://www.gitpod.io/docs/browser-extension' or by prefixing
|
| 17 | ## 'https://gitpod.io#' to the source control URL of any project.
|
| 18 | ##
|
| 19 | ## For example: 'https://gitpod.io#https://github.com/gitpod-io/gitpod'
|
| 20 |
|
| 21 |
|
| 22 | ## The 'image' section defines which Docker image Gitpod should use.
|
| 23 | ## By default, Gitpod uses a standard Docker Image called 'workspace-full'
|
| 24 | ## which can be found at 'https://github.com/gitpod-io/workspace-images'
|
| 25 | ##
|
| 26 | ## Workspaces started based on this default image come pre-installed with
|
| 27 | ## Docker, Go, Java, Node.js, C/C++, Python, Ruby, Rust, PHP as well as
|
| 28 | ## tools such as Homebrew, Tailscale, Nginx and several more.
|
| 29 | ##
|
| 30 | ## If this image does not include the tools needed for your project then
|
| 31 | ## a public Docker image or your own Docker file can be configured.
|
| 32 | ##
|
| 33 | ## Learn more about images at 'https://www.gitpod.io/docs/config-docker'
|
| 34 |
|
| 35 | #image: node:buster # use 'https://hub.docker.com/_/node'
|
| 36 | #
|
| 37 | #image: # leave image undefined if using a Dockerfile
|
| 38 | # file: .gitpod.Dockerfile # relative path to the Dockerfile from the
|
| 39 | # # root of the project
|
| 40 |
|
| 41 | ## The 'tasks' section defines how Gitpod prepares and builds this project
|
| 42 | ## or how Gitpod can start development servers. With Gitpod, there are three
|
| 43 | ## types of tasks:
|
| 44 | ##
|
| 45 | ## - before: Use this for tasks that need to run before init and before command.
|
| 46 | ## - init: Use this to configure prebuilds of heavy-lifting tasks such as
|
| 47 | ## downloading dependencies or compiling source code.
|
| 48 | ## - command: Use this to start your database or application when the workspace starts.
|
| 49 | ##
|
| 50 | ## Learn more about these tasks at 'https://www.gitpod.io/docs/config-start-tasks'
|
| 51 |
|
| 52 | #tasks:
|
| 53 | # - before: |
|
| 54 | # # commands to execute...
|
| 55 | #
|
| 56 | # - init: |
|
| 57 | # # sudo apt-get install python3 # can be used to install operating system
|
| 58 | # # dependencies but these are not kept after the
|
| 59 | # # prebuild completes thus Gitpod recommends moving
|
| 60 | # # operating system dependency installation steps
|
| 61 | # # to a custom Dockerfile to make prebuilds faster
|
| 62 | # # and to keep your codebase DRY.
|
| 63 | # # 'https://www.gitpod.io/docs/config-docker'
|
| 64 | #
|
| 65 | # # pip install -r requirements.txt # install codebase dependencies
|
| 66 | # # cmake # precompile codebase
|
| 67 | #
|
| 68 | # - name: Web Server
|
| 69 | # openMode: split-left
|
| 70 | # env:
|
| 71 | # WEBSERVER_PORT: 8080
|
| 72 | # command: |
|
| 73 | # python3 -m http.server $WEBSERVER_PORT
|
| 74 | #
|
| 75 | # - name: Web Browser
|
| 76 | # openMode: split-right
|
| 77 | # env:
|
| 78 | # WEBSERVER_PORT: 8080
|
| 79 | # command: |
|
| 80 | # gp await-port $WEBSERVER_PORT
|
| 81 | # lynx `gp url`
|
| 82 |
|
| 83 | tasks:
|
| 84 | - name: OSH
|
| 85 | command: |
|
| 86 | build/py.sh gitpod-minimal
|
| 87 |
|
| 88 | ## The 'ports' section defines various ports your may listen on are
|
| 89 | ## configured in Gitpod on an authenticated URL. By default, all ports
|
| 90 | ## are in private visibility state.
|
| 91 | ##
|
| 92 | ## Learn more about ports at 'https://www.gitpod.io/docs/config-ports'
|
| 93 |
|
| 94 | #ports:
|
| 95 | # - port: 8080 # alternatively configure entire ranges via '8080-8090'
|
| 96 | # visibility: private # either 'public' or 'private' (default)
|
| 97 | # onOpen: open-browser # either 'open-browser', 'open-preview' or 'ignore'
|
| 98 |
|
| 99 |
|
| 100 | ## The 'vscode' section defines a list of Visual Studio Code extensions from
|
| 101 | ## the OpenVSX.org registry to be installed upon workspace startup. OpenVSX
|
| 102 | ## is an open alternative to the proprietary Visual Studio Code Marketplace
|
| 103 | ## and extensions can be added by sending a pull-request with the extension
|
| 104 | ## identifier to https://github.com/open-vsx/publish-extensions
|
| 105 | ##
|
| 106 | ## The identifier of an extension is always ${publisher}.${name}.
|
| 107 | ##
|
| 108 | ## For example: 'vscodevim.vim'
|
| 109 | ##
|
| 110 | ## Learn more at 'https://www.gitpod.io/docs/ides-and-editors/vscode'
|
| 111 |
|
| 112 | #vscode:
|
| 113 | # extensions:
|
| 114 | # - vscodevim.vim
|
| 115 | # - esbenp.prettier-vscode@9.5.0
|
| 116 | # - https://example.com/abc/releases/extension-0.26.0.vsix
|
| 117 |
|
| 118 |
|
| 119 | ## The 'github' section defines configuration of continuous prebuilds
|
| 120 | ## for GitHub repositories when the GitHub application
|
| 121 | ## 'https://github.com/apps/gitpod-io' is installed in GitHub and granted
|
| 122 | ## permissions to access the repository.
|
| 123 | ##
|
| 124 | ## Learn more at 'https://www.gitpod.io/docs/prebuilds'
|
| 125 |
|
| 126 | github:
|
| 127 | prebuilds:
|
| 128 | # enable for the default branch
|
| 129 | master: true
|
| 130 | # enable for all branches in this repo
|
| 131 | branches: true
|
| 132 | # enable for pull requests coming from this repo
|
| 133 | pullRequests: true
|
| 134 | # enable for pull requests coming from forks
|
| 135 | pullRequestsFromForks: true
|
| 136 | # add a check to pull requests
|
| 137 | addCheck: true
|
| 138 | # add a "Review in Gitpod" button as a comment to pull requests
|
| 139 | addComment: false
|
| 140 | # add a "Review in Gitpod" button to the pull request's description
|
| 141 | addBadge: true
|