Skip to content

Commit

Permalink
Add CI, Makefile and PR template (#76)
Browse files Browse the repository at this point in the history
* Add basic build commands

* Add PR template

* Add GHA CI

* Remove .drone.yml
  • Loading branch information
tomleb authored Apr 23, 2024
1 parent a5f0818 commit 9da880f
Show file tree
Hide file tree
Showing 6 changed files with 61 additions and 17 deletions.
13 changes: 0 additions & 13 deletions .drone.yml

This file was deleted.

24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Issue: <!-- link the issue or issues this PR resolves here -->

<!-- If your PR depends on changes from other PRs, link them here and describe
why they are needed for your solution section. -->

## Problem

<!-- Describe the root cause of the issue you are resolving. This may include
what behavior is observed and why it is not desirable. If this is a new feature,
describe why we need it and how it will be used. -->

## Solution

<!-- Describe what you changed to fix the issue. Relate your changes to the
original bug/feature and explain why this addresses the issue. -->

## CheckList

<!--
Test:
PRs should be accompanied by tests, even if there isn't a single test yet.
If this PR does not require additional tests, state the reason below for reviewers.
-->
- [ ] Test
15 changes: 15 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: CI
on: [push, pull_request]
jobs:
ci:
runs-on: ubuntu-latest
steps:
- name: Checkout code
# https://github.com/actions/checkout/releases/tag/v4.1.1
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- name: Install Go
# https://github.com/actions/setup-go/releases/tag/v5.0.0
uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
with:
go-version-file: 'go.mod'
- run: make test
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
.idea
.idea
/client/client
/dummy/dummy
/server/server
15 changes: 15 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
all: client dummy server

client:
go build -o client/client ./client

dummy:
go build -o dummy/dummy ./dummy

server:
go build -o server/server ./server

test:
go test -cover ./...

.PHONY: all client dummy server test
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ standalone mode FOR TESTING ONLY. These are found in the `server/` and
Compile the server and client:

```
go build -o server/server server/main.go
go build -o client/client client/main.go
make server
make client
```

### Run
Expand All @@ -127,7 +127,7 @@ target. The remotedialer server also needs to be reachable by the client.
For testing purposes, a basic HTTP file server is provided. Build the server with:

```
go build -o dummy/dummy dummy/main.go
make dummy
```

Create a directory with files to serve, then run the web server from that directory:
Expand Down

0 comments on commit 9da880f

Please sign in to comment.