From b3b22c8e9a6443825684225f9487a81e1cf39d07 Mon Sep 17 00:00:00 2001 From: Ajay Kidave Date: Sat, 28 Oct 2023 14:36:40 -0700 Subject: [PATCH] Updated readme --- .goreleaser-nightly.yaml | 22 -------------------- Makefile | 35 -------------------------------- README.md | 7 ++++--- tests/disk_usage/config_gen.lock | 12 ----------- 4 files changed, 4 insertions(+), 72 deletions(-) delete mode 100644 .goreleaser-nightly.yaml delete mode 100644 Makefile delete mode 100644 tests/disk_usage/config_gen.lock diff --git a/.goreleaser-nightly.yaml b/.goreleaser-nightly.yaml deleted file mode 100644 index 0daaf77..0000000 --- a/.goreleaser-nightly.yaml +++ /dev/null @@ -1,22 +0,0 @@ -project_name: clace - -builds: - - main: ./cmd/clace - id: clace - binary: clace - ldflags: - - -w -X github.com/claceio/clace/server.gitCommit={{.ShortCommit}} - env: - - GO111MODULE=on - - CGO_ENABLED=0 - goos: - - linux - goarch: - - amd64 - -checksum: - name_template: "SHA256SUMS" - algorithm: sha256 - -snapshot: - name_template: '{{ if index .Env "IMAGE_NAME" }}{{ .Env.IMAGE_NAME }}{{ else if not (eq .Branch "main" "dev" "") }}{{ replace .Branch "/" "-" }}{{ else }}nightly{{ end }}-{{ time "20060102" }}' diff --git a/Makefile b/Makefile deleted file mode 100644 index 7fa0e45..0000000 --- a/Makefile +++ /dev/null @@ -1,35 +0,0 @@ -## Copyright (c) Clace Inc -## SPDX-License-Identifier: Apache-2.0 - -IMAGE_REPO ?= claceio/clace - -vet: ## Run go vet - go vet ./... - -tidy: ## Run go mod tidy - go mod tidy - -buildwindows: ## Build clace CLI for windows/amd64 - GOOS=windows GOARCH=amd64 go install github.com/claceio/clace/cmd/clace - -build386: ## Build clace CLI for linux/386 - GOOS=linux GOARCH=386 go install github.com/claceio/clace/cmd/clace - -buildlinuxarm: ## Build clace CLI for linux/arm - GOOS=linux GOARCH=arm go install github.com/claceio/clace/cmd/clace - -buildlinuxloong64: ## Build clace CLI for linux/loong64 - GOOS=linux GOARCH=loong64 go install github.com/claceio/clace/cmd/clace - -check: staticcheck vet buildwindows build386 buildlinuxarm ## Perform basic checks and compilation tests - -staticcheck: ## Run staticcheck.io checks - go run honnef.co/go/tools/cmd/staticcheck -- $$(go list ./...) - -help: ## Show this help - @echo "\nSpecify a command. The choices are:\n" - @grep -hE '^[0-9a-zA-Z_-]+:.*?## .*$$' ${MAKEFILE_LIST} | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[0;36m%-20s\033[m %s\n", $$1, $$2}' - @echo "" -.PHONY: help - -.DEFAULT_GOAL := help diff --git a/README.md b/README.md index 1e1fdd9..6ab8f28 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,8 @@ The deployment features supported currently by Clace are: - Backend app code run in a [security sandbox](https://clace.io/docs/applications/appsecurity/#security-model), with allowlist based permissions. - [No build step](https://clace.io/docs/app/overview/#app-lifecycle), the development artifacts are ready for production use. +- Support for github integration, apps being directly deployed from github code. +- Database backed application file system, for atomic version updates and rollbacks. - Zero downtime application updates. - Scalable backend, all performance critical code is in Go, only application handler code is in Starlark. - Support for domain based and path based [routing](https://clace.io/docs/applications/routing/#request-routing) at the app level. @@ -60,9 +62,8 @@ Clace is early in its development. The feature roadmap for Clace is: - Support for OAuth2 based login. - Support for SSO with SAML. - All plugins are internal (built into Clace binary) currently. The plan is to move to an external plugin model, plugins being loaded dynamically using [go-plugin](/~https://github.com/hashicorp/go-plugin). -- Support for github integration, apps being deployed from artifacts directly loaded from github. -- SQLite is used as the metadata storage currently. Support for postgres and other systems is planned. -- Preview mode for app updates, to check whether changes work before making them live. +- SQLite is used for metadata storage currently. Support for postgres and other systems is planned. +- Staging mode for app updates, to verify whether changes work before making them live. - Support for workflow jobs, which would have a form based interface with limited customizability, but with support for triggered and scheduled execution. - Support for application data persistance. - UI interface for Clace admin operations. diff --git a/tests/disk_usage/config_gen.lock b/tests/disk_usage/config_gen.lock deleted file mode 100644 index ef93f16..0000000 --- a/tests/disk_usage/config_gen.lock +++ /dev/null @@ -1,12 +0,0 @@ -{ - "routing": { - "template_locations": [ - "*.go.html" - ], - "static_dir": "static", - "push_events": false - }, - "htmx": { - "version": "1.9.2" - } -} \ No newline at end of file