Tidy repo (#30)

* Tidy repo

* Tidy

* Fix up

* Setup default target
pull/26/merge
Malachi Soord 2023-11-19 21:33:18 +01:00 committed by GitHub
parent 4e399f63ea
commit 9c2a0dbefe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 21 deletions

View File

@ -15,7 +15,7 @@ jobs:
- name: Set up Go - name: Set up Go
uses: actions/setup-go@v4 uses: actions/setup-go@v4
with: with:
go-version: ^1.15 go-version: '1.20.2'
- name: Check out code - name: Check out code
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: Build - name: Build

View File

@ -1,11 +1,9 @@
FROM golang:latest FROM golang:1.20.2
WORKDIR /app WORKDIR /app
COPY ./ /app COPY ./ /app
RUN go mod download RUN go install github.com/githubnemo/CompileDaemon@latest
RUN go get github.com/githubnemo/CompileDaemon ENTRYPOINT CompileDaemon --build="make build" --command=./bin/edgeboxctl-$(go env GOOS)-$(go env GOARCH)
ENTRYPOINT CompileDaemon --build="make build" --command=./bin/edgeboxctl

View File

@ -1,9 +1,13 @@
PROJECT?=github.com/edgebox-iot/edgeboxctl .DEFAULT_GOAL := build
PROJECT ?= github.com/edgebox-iot/edgeboxctl
RELEASE ?= dev RELEASE ?= dev
COMMIT := $(shell git rev-parse --short HEAD) COMMIT := $(shell git rev-parse --short HEAD)
BUILD_DATE := $(shell date -u '+%Y-%m-%d_%H:%M:%S') BUILD_DATE := $(shell date -u '+%Y-%m-%d_%H:%M:%S')
BUILD_DIR = bin BUILD_DIR = bin
GOOS := $(shell go env GOOS)
GOARCH := $(shell go env GOARCH)
build-all: build-all:
GOOS=linux GOARCH=amd64 make build GOOS=linux GOARCH=amd64 make build
@ -32,7 +36,6 @@ build:
-X ${PROJECT}/internal/diagnostics.Commit=${COMMIT} \ -X ${PROJECT}/internal/diagnostics.Commit=${COMMIT} \
-X ${PROJECT}/internal/diagnostics.BuildDate=${BUILD_DATE}" \ -X ${PROJECT}/internal/diagnostics.BuildDate=${BUILD_DATE}" \
-o bin/edgeboxctl-${GOOS}-${GOARCH} ${PROJECT}/cmd/edgeboxctl -o bin/edgeboxctl-${GOOS}-${GOARCH} ${PROJECT}/cmd/edgeboxctl
cp ./bin/edgeboxctl-${GOOS}-${GOARCH} ./bin/edgeboxctl
clean: clean:
rm -rf ${BUILD_DIR} rm -rf ${BUILD_DIR}
@ -68,4 +71,3 @@ stop:
log: start log: start
journalctl -fu edgeboxctl journalctl -fu edgeboxctl

View File

@ -8,7 +8,7 @@
<h3 align="center">Edgebox Control Module</h3> <h3 align="center">Edgebox Control Module</h3>
<p align="center"> <p align="center">
A System Control module written in Go. Its resonsability is to configure dependencies and perform system tasks, automatically in a schedule, or by command. A System Control module written in Go. Its responsibility is to configure dependencies and perform system tasks, automatically on a schedule, or on demand.
<br /> <br />
<br /> <br />
<a href="https://github.com/github_username/edgeboxctl/issues">Report Bug</a> <a href="https://github.com/github_username/edgeboxctl/issues">Report Bug</a>
@ -38,8 +38,6 @@
<!-- ABOUT THE PROJECT --> <!-- ABOUT THE PROJECT -->
## About The Project ## About The Project
[![Edgebox Screen Shot][product-screenshot]](https://edgebox.co)
Edgebox is an easy to configure and use system. It brings powerful features that go alongside or can even completely replace various services that you already use in the day-to-day. Edgebox is an easy to configure and use system. It brings powerful features that go alongside or can even completely replace various services that you already use in the day-to-day.
@ -58,18 +56,15 @@ To get a local copy up and running follow these simple steps.
### Prerequisites ### Prerequisites
If you're installing this to run natively in the system, you better be doing it inside of the [Development Virtual Machine](https://github.com/edgebox-iot/devm). This software can do destructive action in the system is is running. You've been warned. If you're running for development purposes, a docker container suffices, so make sure you have:
If you're running for development purposes, a Docker container suffices, so make sure you have: * docker
* Docker * docker compose
* Docker Compose
```sh
sudo apt-get install docker docker-compose
```
Check the following links for more info on [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/). Check the following links for more info on [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/).
Aditionally, edgeboxctl needs the following bash commands available wherever it runs: Aditionally, `edgeboxctl` needs the following bash commands available wherever it runs:
* `arm-linux-gnueabi-gcc` (`sudo apt-get install gcc-arm*`) * `arm-linux-gnueabi-gcc` (`sudo apt-get install gcc-arm*`)
* `sh` * `sh`
* `rm` * `rm`
@ -121,4 +116,4 @@ Contributions are what make the open source community such an amazing place to b
<!-- LICENSE --> <!-- LICENSE -->
## License ## License
Distributed under the MIT License. See `LICENSE` for more information. Distributed under the Elastic License 2.0. See `LICENSE` for more information.