Merge pull request #321 from onepanelio/dev

chore: dev > master  (v0.10.0)

Author: rushtehrani

.github/workflows/push_develop_branch.yaml renamed to .github/workflows/push_dev_branch.yaml

@@ -1,8 +1,8 @@
-name: Publish develop docker image
+name: Publish dev docker image
 on:
   push:
     branches:
-      - develop
+      - dev
 jobs:
   build:
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -49,7 +49,7 @@ Make sure that your `$GOBIN` is in your `$PATH`.
 
 Generate Go and Swagger APIs:
 ```bash
-make api
+make api version=1.0.0
 ```
 
 ## Minikube Debugging and Development
@@ -122,6 +122,8 @@ After this, build main.go and run the executable.
 
 ## Code Structure & Organization
 
+### `utils` dir
+
 ```shell script
 utils/*.go
 ```
@@ -150,4 +152,25 @@ These can be pulled out into their own package or into a new v2 directory if nee
 You can add
 - kubernetes specific operations
 - database specific operations
-- types
+- types
+
+### `cmd` dir
+Each source file here is assumed to result in an executable.
+- Hence the `package main` at the top of each
+
+Place each source file into it's own folder.
+Example source file name: `flush_cache.go`
+- Dir structure: `cmd/flush-cache/flush_cache.go`
+
+To avoid errors like this during docker build
+```text
+# github.com/onepanelio/core/cmd
+cmd/goose.go:22:6: main redeclared in this block
+        previous declaration at cmd/gen-release-md.go:136:6
+github.com/onepanelio/core
+```
+Caused by
+```dockerfile
+RUN go install -v ./...
+```
+

Dockerfile

@@ -5,11 +5,13 @@ COPY . .
 
 RUN go get -d -v ./...
 RUN go install -v ./...
-
+RUN go get -u github.com/pressly/goose/cmd/goose
+RUN go build -o /go/bin/goose ./cmd/goose/goose.go
 
 FROM golang:1.13.10
 COPY --from=builder /go/bin/core .
 COPY --from=builder /go/src/db ./db
+COPY --from=builder /go/bin/goose .
 
 EXPOSE 8888
 EXPOSE 8887

Makefile

@@ -1,9 +1,17 @@
 COMMIT_HASH=$(shell git rev-parse --short HEAD)
 
+.PHONY: init
+
+init:
+ifndef version
+	$(error version is undefined)
+endif
+
 jq:
 	cat api/apidocs.swagger.json \
 		| jq 'walk( if type == "object" then with_entries( .key |= sub( "api\\."; "") ) else . end )' \
 		| jq 'walk( if type == "string" then gsub( "api\\."; "") else . end )' \
+		| jq '.info.version = "$(version)"' \
 		> api/api.swagger.json
 	rm api/apidocs.swagger.json
 
@@ -16,7 +24,7 @@ protoc:
  		--grpc-gateway_out=logtostderr=true,allow_delete_body=true:api \
  		--swagger_out=allow_merge=true,fqn_for_swagger_name=true,allow_delete_body=true,logtostderr=true,simple_operation_ids=true:api
 
-api: protoc jq
+api: init protoc jq
 
 docker-build:
 	docker build -t onepanel-core .

api/api.pb.go

@@ -6,11 +6,11 @@ import "protoc-gen-swagger/options/annotations.proto";
 
 option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
     info: {
-        title: "Onepanel Core";
-        description: "Onepanel Core project API";
-        version: "1.0.0-beta1";
+        title: "Onepanel";
+        description: "Onepanel API";
+        version: "0.10.0";
 		contact: {
-			name: "Onepanel Core project";
+			name: "Onepanel project";
 			url: "https://github.com/onepanelio/core";
 		};
     };

api/api.proto

@@ -1,11 +1,11 @@
 {
   "swagger": "2.0",
   "info": {
-    "title": "Onepanel Core",
-    "description": "Onepanel Core project API",
-    "version": "1.0.0-beta1",
+    "title": "Onepanel",
+    "description": "Onepanel API",
+    "version": "0.10.0",
     "contact": {
-      "name": "Onepanel Core project",
+      "name": "Onepanel project",
       "url": "https://github.com/onepanelio/core"
     }
   },
@@ -3167,6 +3167,9 @@
         "createdAt": {
           "type": "string"
         },
+        "modifiedAt": {
+          "type": "string"
+        },
         "uid": {
           "type": "string"
         },

api/api.swagger.json

@@ -135,18 +135,18 @@ message CronWorkflowStatisticsReport {
 
 message WorkflowTemplate {
     string createdAt = 1;
-    string uid = 2;
-    string name = 3;
-    int64 version = 4;
-    int64 versions = 5;
-    string manifest = 6;
-    bool isLatest = 7;
-    bool isArchived = 8;
-    repeated KeyValue labels = 9;
-
-    WorkflowExecutionStatisticReport stats = 10;
-    CronWorkflowStatisticsReport cronStats = 11;
-
+    string modifiedAt = 2;
+    string uid = 3;
+    string name = 4;
+    int64 version = 5;
+    int64 versions = 6;
+    string manifest = 7;
+    bool isLatest = 8;
+    bool isArchived = 9;
+    repeated KeyValue labels = 10;
+
+    WorkflowExecutionStatisticReport stats = 11;
+    CronWorkflowStatisticsReport cronStats = 12;
 }
 
 message GetWorkflowTemplateLabelsRequest {

api/workflow_template.pb.go

@@ -0,0 +1,17 @@
+# Helper scripts
+
+## gen-release-md.go
+Generates markdown for releases.
+
+Usage:
+```bash
+go run cmd/gen-release-md/gen-release-md.go -v=0.10.0 > /tmp/release.md
+```
+
+## goose.go
+Supports both Go and SQL migrations.
+
+```bash
+go run cmd/goose/goose up     # run up migrations
+go run cmd/goose/goose down   # run down migrations
+```