From 6ae4a212974f21c2a52492f6aca5fcacbcc382d4 Mon Sep 17 00:00:00 2001 From: Geoffrey Huntley Date: Tue, 4 May 2021 11:55:10 +0000 Subject: [PATCH] Fully-automate development setup with Gitpod Signed-off-by: Geoffrey Huntley --- .gitpod.Dockerfile | 1 + .gitpod.yml | 20 ++++++++++++++++++++ CONTRIBUTING.md | 5 +++++ README.md | 2 +- 4 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 .gitpod.Dockerfile create mode 100644 .gitpod.yml create mode 100644 CONTRIBUTING.md diff --git a/.gitpod.Dockerfile b/.gitpod.Dockerfile new file mode 100644 index 00000000..11afbf8e --- /dev/null +++ b/.gitpod.Dockerfile @@ -0,0 +1 @@ +FROM node:16-buster diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 00000000..1c012315 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,20 @@ +image: + file: .gitpod.Dockerfile + +# List the start up tasks. You can start them in parallel in multiple terminals. +# https://www.gitpod.io/docs/config-start-tasks/ +tasks: + - init: > + npm install && + npm run build + command: npm run test + +# Enable prebuilds of your project to enable faster workspace start times. +# https://www.gitpod.io/docs/prebuilds/#configure-the-github-app +github: + prebuilds: + master: true + branches: true + pullRequests: true + pullRequestsFromForks: true + addCheck: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..bd7a8933 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +## Hacking on Serverless Workflow Typescript SDK in Gitpod + +If you have a web browser, you can get a fully pre-configured development environment in one click: + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/serverlessworkflow/sdk-typescript) diff --git a/README.md b/README.md index ddc8432f..26306d36 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Node CI](https://github.com/serverlessworkflow/sdk-typescript/workflows/Node%20CI/badge.svg) +![Node CI](https://github.com/serverlessworkflow/sdk-typescript/workflows/Node%20CI/badge.svg) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/serverlessworkflow/sdk-typescript) # Serverless Workflow Specification - Typescript SDK