tree: 19b44a0c35a9b8aba2e0799dba3bbed35c6339e7 [path history] [tgz]
  1. .eslintrc.yaml
  2. .prettierrc.yaml
  3. .stylelintrc.yaml
  4. cloudbuild.yaml
  5. deployment-prod.yaml
  6. Dockerfile
  7. Dockerfile.node
  8. Dockerfile.test
  9. main.go
  10. Makefile
  11. package-lock.json
  12. package.json
  13. README.md
  14. sqlc.yaml
cmd/relui/README.md

golang.org/x/build/cmd/relui

               ▀▀█             ▀
  ▄ ▄▄   ▄▄▄     █    ▄   ▄  ▄▄▄
  █▀  ▀ █▀  █    █    █   █    █
  █     █▀▀▀▀    █    █   █    █
  █     ▀█▄▄▀    ▀▄▄  ▀▄▄▀█  ▄▄█▄▄

relui is a web interface for managing the release process of Go.

Development

Run the command with the appropriate libpq-style environment variables set.

PGHOST=localhost PGDATABASE=relui-dev PGUSER=postgres go run . -listen-http=localhost:8080

Alternatively, using docker:

make dev

Updating Queries

Create or edit SQL files in internal/relui/queries. After editing the query, run sqlc generate in this directory. The internal/relui/db package contains the generated code.

See sqlc documentation for further details.

Creating & Running Database Migrations

Migrations are managed using github.com/golang-migrate/migrate.

Creating

go run -tags pgx github.com/golang-migrate/migrate/v4/cmd/migrate \
  create \
  --dir ../../internal/relui/migrations/ \
  -ext sql \
  my_fancy_migration
# alternatively, install the migrate command with pgx support.

Running

Migrations are automatically ran on application launch. “Down” migrations are not automatically run and must be manually invoked in psql, or by the --migrate-down-up flag or make migrate-down-up.

Testing

Run go test with the appropriate libpq-style environment variables set. If the database connection fails, database integration tests will be skipped. If PGDATABASE is unset, relui-test is created, migrated, and used by default.

PGHOST=localhost PGUSER=postgres go test -v ./... ../../internal/relui/...

Alternatively, using docker:

make test

Deployment

See the documentation on deployment.

JS/CSS formatting and lint

This project uses eslint and stylelint to format JavaScript and CSS files.

To run:

npm run lint

Alternatively, using Docker:

make lint