From 8e67d28c4fddfc0b4f4f0dd5db1e60e4d80cf56a Mon Sep 17 00:00:00 2001
From: 6543 <6543@obermui.de>
Date: Fri, 11 Nov 2022 23:51:45 +0100
Subject: [PATCH] Add editorconfig, fix files and lint via ci
---
.ecrc | 9 +++++++++
.editorconfig | 17 +++++++++++++++++
.woodpecker.yml | 4 ++++
Dockerfile | 4 ++--
Justfile | 1 +
README.md | 8 +++-----
haproxy-sni/dhparam.pem | 2 +-
haproxy-sni/docker-compose.yml | 2 +-
html/404.html | 6 +++---
9 files changed, 41 insertions(+), 12 deletions(-)
create mode 100644 .ecrc
create mode 100644 .editorconfig
diff --git a/.ecrc b/.ecrc
new file mode 100644
index 0000000..d9ee788
--- /dev/null
+++ b/.ecrc
@@ -0,0 +1,9 @@
+{
+ "Exclude": [
+ ".git",
+ "go.mod", "go.sum",
+ "vendor",
+ "LICENSE",
+ "_test.go"
+ ]
+}
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..354a828
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,17 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+tab_width = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.go]
+indent_style = tab
+
+[*.md]
+trim_trailing_whitespace = false
+indent_size = 1
diff --git a/.woodpecker.yml b/.woodpecker.yml
index db51eba..5c9a7fd 100644
--- a/.woodpecker.yml
+++ b/.woodpecker.yml
@@ -15,6 +15,10 @@ pipeline:
- "[ $(gofumpt -extra -l . | wc -l) != 0 ] && { echo 'code not formated'; exit 1; }"
- golangci-lint run --timeout 5m --build-tags integration
+ editor-config:
+ group: compliant
+ image: mstruebing/editorconfig-checker
+
build:
group: compliant
image: codeberg.org/6543/docker-images/golang_just
diff --git a/Dockerfile b/Dockerfile
index 71dd236..904d6f4 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -11,5 +11,5 @@ COPY --from=build /workspace/pages /pages
COPY --from=build \
/etc/ssl/certs/ca-certificates.crt \
/etc/ssl/certs/ca-certificates.crt
-
-ENTRYPOINT ["/pages"]
\ No newline at end of file
+
+ENTRYPOINT ["/pages"]
diff --git a/Justfile b/Justfile
index 03a7436..f7ea414 100644
--- a/Justfile
+++ b/Justfile
@@ -18,6 +18,7 @@ build-tag VERSION:
lint: tool-golangci tool-gofumpt
[ $(gofumpt -extra -l . | wc -l) != 0 ] && { echo 'code not formated'; exit 1; }; \
golangci-lint run --timeout 5m --build-tags integration
+ # TODO: run editorconfig-checker
fmt: tool-gofumpt
gofumpt -w --extra .
diff --git a/README.md b/README.md
index c4758ac..50cdc3c 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,6 @@ It is suitable to be deployed by other Gitea instances, too, to offer static pag
**End user documentation** can mainly be found at the [Wiki](https://codeberg.org/Codeberg/pages-server/wiki/Overview)
and the [Codeberg Documentation](https://docs.codeberg.org/codeberg-pages/).
-
## Quickstart
This is the new Codeberg Pages server, a solution for serving static pages from Gitea repositories.
@@ -20,17 +19,16 @@ first line will be the canonical domain/URL; all other occurrences will be redir
2) add a CNAME entry to your domain, pointing to `[[{branch}.]{repo}.]{owner}.codeberg.page` (repo defaults to
"pages", "branch" defaults to the default branch if "repo" is "pages", or to "pages" if "repo" is something else.
If the branch name contains slash characters, you need to replace "/" in the branch name to "~"):
- `www.example.org. IN CNAME main.pages.example.codeberg.page.`
+ `www.example.org. IN CNAME main.pages.example.codeberg.page.`
3) if a CNAME is set for "www.example.org", you can redirect there from the naked domain by adding an ALIAS record
for "example.org" (if your provider allows ALIAS or similar records, otherwise use A/AAAA), together with a TXT
record that points to your repo (just like the CNAME record):
- `example.org IN ALIAS codeberg.page.`
- `example.org IN TXT main.pages.example.codeberg.page.`
+ `example.org IN ALIAS codeberg.page.`
+ `example.org IN TXT main.pages.example.codeberg.page.`
Certificates are generated, updated and cleaned up automatically via Let's Encrypt through a TLS challenge.
-
## Deployment
**Warning: Some Caveats Apply**
diff --git a/haproxy-sni/dhparam.pem b/haproxy-sni/dhparam.pem
index 088f967..9b182b7 100644
--- a/haproxy-sni/dhparam.pem
+++ b/haproxy-sni/dhparam.pem
@@ -5,4 +5,4 @@ MIIBCAKCAQEA//////////+t+FRYortKmq/cViAnPTzx2LnFg84tNpWp4TZBFGQz
YdEIqUuyyOP7uWrat2DX9GgdT0Kj3jlN9K5W7edjcrsZCwenyO4KbXCeAvzhzffi
7MA0BM0oNC9hkXL+nOmFg/+OTxIy7vKBg8P+OxtMb61zO7X8vC7CIAXFjvGDfRaD
ssbzSibBsu/6iGtCOGEoXJf//////////wIBAg==
------END DH PARAMETERS-----
\ No newline at end of file
+-----END DH PARAMETERS-----
diff --git a/haproxy-sni/docker-compose.yml b/haproxy-sni/docker-compose.yml
index 4dd8677..66ff52b 100644
--- a/haproxy-sni/docker-compose.yml
+++ b/haproxy-sni/docker-compose.yml
@@ -19,4 +19,4 @@ services:
volumes:
- ./pages-www:/srv:ro
- ./pages.Caddyfile:/etc/caddy/Caddyfile:ro
-
+
diff --git a/html/404.html b/html/404.html
index b7ec96e..21d968e 100644
--- a/html/404.html
+++ b/html/404.html
@@ -23,11 +23,11 @@
- Page not found!
+ Page not found!
- Sorry, but this page couldn't be found or is inaccessible (%status).
- We hope this isn't a problem on our end ;) - Make sure to check the troubleshooting section in the Docs!
+ Sorry, but this page couldn't be found or is inaccessible (%status).
+ We hope this isn't a problem on our end ;) - Make sure to check the troubleshooting section in the Docs!
