Basic golang CI setup (#360)
* bskyweb: Makefile and dev env This matches the setup for local dev testing in atproto and indigo repos. * gitignore: don't ignore self and .github/ * CI: golang build+test and lint actions * bskyweb: better use of godotenv A recent change from indigo. * prettier: ignore top-level app.json * CI: bump from golang 1.19 to 1.20 * bskyweb: update to golang 1.20zio/stable
parent
4fbe0e267c
commit
2789d5c056
|
@ -0,0 +1,43 @@
|
||||||
|
name: golang
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: '${{ github.workflow }}-${{ github.head_ref || github.ref }}'
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build-and-test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Git Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
- name: Set up Go tooling
|
||||||
|
uses: actions/setup-go@v3
|
||||||
|
with:
|
||||||
|
go-version: 1.20
|
||||||
|
- name: Dummy JS File
|
||||||
|
run: touch bskyweb/static/js/blah.js
|
||||||
|
- name: Check
|
||||||
|
run: cd bskyweb/ && make check
|
||||||
|
- name: Build (binary)
|
||||||
|
run: cd bskyweb/ && make build
|
||||||
|
- name: Test
|
||||||
|
run: cd bskyweb/ && make test
|
||||||
|
lint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Git Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
- name: Set up Go tooling
|
||||||
|
uses: actions/setup-go@v3
|
||||||
|
with:
|
||||||
|
go-version: 1.20
|
||||||
|
- name: Dummy JS File
|
||||||
|
run: touch bskyweb/static/js/blah.js
|
||||||
|
- name: Lint
|
||||||
|
run: cd bskyweb/ && make lint
|
|
@ -81,3 +81,7 @@ web-build/
|
||||||
|
|
||||||
# Temporary files created by Metro to check the health of the file watcher
|
# Temporary files created by Metro to check the health of the file watcher
|
||||||
.metro-health-check*
|
.metro-health-check*
|
||||||
|
|
||||||
|
# gitignore and github actions
|
||||||
|
!.gitignore
|
||||||
|
!.github
|
||||||
|
|
|
@ -6,6 +6,7 @@ public
|
||||||
/bskyweb/templates
|
/bskyweb/templates
|
||||||
/dist/
|
/dist/
|
||||||
/.watchmanconfig
|
/.watchmanconfig
|
||||||
|
/app.json
|
||||||
|
|
||||||
web/index.html
|
web/index.html
|
||||||
web-build/*
|
web-build/*
|
||||||
|
|
|
@ -1,4 +1,8 @@
|
||||||
.env
|
.env
|
||||||
|
test-coverage.out
|
||||||
|
|
||||||
# Don't check in the binary.
|
# Don't check in the binary.
|
||||||
/bskyweb
|
/bskyweb
|
||||||
|
|
||||||
|
# Don't ignore this file
|
||||||
|
!.gitignore
|
||||||
|
|
|
@ -0,0 +1,42 @@
|
||||||
|
|
||||||
|
SHELL = /bin/bash
|
||||||
|
.SHELLFLAGS = -o pipefail -c
|
||||||
|
|
||||||
|
.PHONY: help
|
||||||
|
help: ## Print info about all commands
|
||||||
|
@echo "Commands:"
|
||||||
|
@echo
|
||||||
|
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[01;32m%-20s\033[0m %s\n", $$1, $$2}'
|
||||||
|
|
||||||
|
.PHONY: build
|
||||||
|
build: ## Build all executables
|
||||||
|
go build ./cmd/bskyweb
|
||||||
|
|
||||||
|
.PHONY: test
|
||||||
|
test: ## Run all tests
|
||||||
|
go test ./...
|
||||||
|
|
||||||
|
.PHONY: coverage-html
|
||||||
|
coverage-html: ## Generate test coverage report and open in browser
|
||||||
|
go test ./... -coverpkg=./... -coverprofile=test-coverage.out
|
||||||
|
go tool cover -html=test-coverage.out
|
||||||
|
|
||||||
|
.PHONY: lint
|
||||||
|
lint: ## Verify code style and run static checks
|
||||||
|
go vet ./...
|
||||||
|
test -z $(gofmt -l ./...)
|
||||||
|
|
||||||
|
.PHONY: fmt
|
||||||
|
fmt: ## Run syntax re-formatting (modify in place)
|
||||||
|
go fmt ./...
|
||||||
|
|
||||||
|
.PHONY: check
|
||||||
|
check: ## Compile everything, checking syntax (does not output binaries)
|
||||||
|
go build ./...
|
||||||
|
|
||||||
|
.env:
|
||||||
|
if [ ! -f ".env" ]; then cp example.dev.env .env; fi
|
||||||
|
|
||||||
|
.PHONY: run-dev-bskyweb
|
||||||
|
run-dev-bskyweb: .env ## Runs 'bskyweb' for local dev
|
||||||
|
GOLOG_LOG_LEVEL=info go run ./cmd/bskyweb serve
|
|
@ -24,7 +24,7 @@ Then build and copy over the big 'ol `bundle.web.js` file:
|
||||||
|
|
||||||
### Golang Daemon
|
### Golang Daemon
|
||||||
|
|
||||||
Install golang. We are generally using v1.19+.
|
Install golang. We are generally using v1.20+.
|
||||||
|
|
||||||
In this directory (`bskyweb/`):
|
In this directory (`bskyweb/`):
|
||||||
|
|
||||||
|
|
|
@ -3,8 +3,9 @@ package main
|
||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
|
|
||||||
|
_ "github.com/joho/godotenv/autoload"
|
||||||
|
|
||||||
logging "github.com/ipfs/go-log"
|
logging "github.com/ipfs/go-log"
|
||||||
"github.com/joho/godotenv"
|
|
||||||
"github.com/urfave/cli/v2"
|
"github.com/urfave/cli/v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -16,15 +17,6 @@ func init() {
|
||||||
}
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
|
||||||
// only try dotenv if it exists
|
|
||||||
if _, err := os.Stat(".env"); err == nil {
|
|
||||||
err := godotenv.Load()
|
|
||||||
if err != nil {
|
|
||||||
log.Fatal("Error loading .env file")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
run(os.Args)
|
run(os.Args)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
GOLOG_LOG_LEVEL=info
|
||||||
|
ATP_PDS_HOST=http://localhost:2583
|
||||||
|
ATP_AUTH_HANDLE="admin.test"
|
||||||
|
ATP_AUTH_PASSWORD="admin"
|
|
@ -1,6 +1,6 @@
|
||||||
module github.com/bluesky-social/social-app/bskyweb
|
module github.com/bluesky-social/social-app/bskyweb
|
||||||
|
|
||||||
go 1.19
|
go 1.20
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/bluesky-social/indigo v0.0.0-20230307000525-294e33e70185
|
github.com/bluesky-social/indigo v0.0.0-20230307000525-294e33e70185
|
||||||
|
|
Loading…
Reference in New Issue