Skip to content

Commit f2b39e6

Browse files
joschijoschi
authored
Add support for remote development with Gitpod (#379)
1 parent 4a7f7a9 commit f2b39e6

File tree

2 files changed

+139
-0
lines changed

2 files changed

+139
-0
lines changed

‎.gitpod.yml

+137
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
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+
- init: ./mvnw package -DskipTests
85+
86+
## The 'ports' section defines various ports your may listen on are
87+
## configured in Gitpod on an authenticated URL. By default, all ports
88+
## are in private visibility state.
89+
##
90+
## Learn more about ports at 'https://www.gitpod.io/docs/config-ports'
91+
92+
#ports:
93+
# - port: 8080 # alternatively configure entire ranges via '8080-8090'
94+
# visibility: private # either 'public' or 'private' (default)
95+
# onOpen: open-browser # either 'open-browser', 'open-preview' or 'ignore'
96+
97+
98+
## The 'vscode' section defines a list of Visual Studio Code extensions from
99+
## the OpenVSX.org registry to be installed upon workspace startup. OpenVSX
100+
## is an open alternative to the proprietary Visual Studio Code Marketplace
101+
## and extensions can be added by sending a pull-request with the extension
102+
## identifier to https://github.com/open-vsx/publish-extensions
103+
##
104+
## The identifier of an extension is always ${publisher}.${name}.
105+
##
106+
## For example: 'vscodevim.vim'
107+
##
108+
## Learn more at 'https://www.gitpod.io/docs/ides-and-editors/vscode'
109+
110+
vscode:
111+
extensions:
112+
- redhat.java
113+
- vscjava.vscode-java-pack
114+
115+
## The 'github' section defines configuration of continuous prebuilds
116+
## for GitHub repositories when the GitHub application
117+
## 'https://github.com/apps/gitpod-io' is installed in GitHub and granted
118+
## permissions to access the repository.
119+
##
120+
## Learn more at 'https://www.gitpod.io/docs/prebuilds'
121+
122+
github:
123+
prebuilds:
124+
# enable for the default branch
125+
master: true
126+
# enable for all branches in this repo
127+
branches: true
128+
# enable for pull requests coming from this repo
129+
pullRequests: true
130+
# enable for pull requests coming from forks
131+
pullRequestsFromForks: true
132+
# add a check to pull requests
133+
addCheck: true
134+
# add a "Review in Gitpod" button as a comment to pull requests
135+
addComment: true
136+
# add a "Review in Gitpod" button to the pull request's description
137+
addBadge: false

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Compare two OpenAPI specifications (3.x) and render the difference to HTML plain
55
[![Build](https://github.com/OpenAPITools/openapi-diff/workflows/Main%20Build/badge.svg)](https://github.com/OpenAPITools/openapi-diff/actions?query=branch%3Amaster+workflow%3A"Main+Build")
66
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=OpenAPITools_openapi-diff&metric=alert_status)](https://sonarcloud.io/dashboard?id=OpenAPITools_openapi-diff)
77
[![Maven Central](https://img.shields.io/maven-central/v/org.openapitools.openapidiff/openapi-diff-core)](https://search.maven.org/artifact/org.openapitools.openapidiff/openapi-diff-core)
8+
9+
[![Contribute with Gitpod](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/OpenAPITools/openapi-diff)
810
[![Join the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM)
911

1012
[![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/openapitools/openapi-diff)](https://hub.docker.com/r/openapitools/openapi-diff)

0 commit comments

Comments
 (0)