Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify getting started for newcomers #160

Merged
merged 35 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
0c2d46d
fix: use docker compose instead of docker-compose
gabor-boros Apr 20, 2024
4ef8204
fix: ensure pnpm sharp install is working on Ubuntu
gabor-boros Apr 22, 2024
bdfc0f2
chore: remove deprecated docker-compose versions
gabor-boros Apr 22, 2024
40749ca
refactor: run on plain http by default
gabor-boros Apr 22, 2024
4c4db91
build: restructure setup script
gabor-boros Apr 22, 2024
105bc68
build: refactor Make targets
gabor-boros Apr 22, 2024
57cc196
build: rename pnpm storybook build script
gabor-boros Apr 22, 2024
afd83b9
fix: add role scope to test env config
gabor-boros Apr 22, 2024
ffb67bf
chore: ignore storybook-static dir
gabor-boros Apr 22, 2024
1210b1c
build: add docker-compose project name
gabor-boros Apr 22, 2024
0ea6698
fix: ensure server can start in HTTP mode
gabor-boros Apr 22, 2024
70d85f1
chore: regenerate user-welcome email
gabor-boros Apr 22, 2024
e398733
chore: update pnpm-lock format
gabor-boros Apr 22, 2024
e984c9e
build: refactor front-end client generation
gabor-boros Apr 22, 2024
c7e5665
build: extend makefile with formatters and linters
gabor-boros Apr 22, 2024
3b6f8f9
fix: force recreate in makefile
gabor-boros Apr 22, 2024
55450cc
build: specify stmp container platform
gabor-boros Apr 22, 2024
99556c1
build: k6 tests
gabor-boros Apr 22, 2024
94b3ef9
test: k6 use http BASE_URL
gabor-boros Apr 22, 2024
3aec67a
fix: ensure pnpm commands executed successfully
gabor-boros Apr 22, 2024
41f64b5
fix: ensure node 20 required
gabor-boros Apr 22, 2024
b23ce83
docs: update contributing guide
gabor-boros Apr 22, 2024
6299084
test: temporarily disable mobile target
gabor-boros Apr 22, 2024
f159530
ci: refactor CI tests
gabor-boros Apr 22, 2024
fec6911
build: execute pnpm prefixed commands
gabor-boros Apr 22, 2024
1120290
fix: ensure database name set correctly
gabor-boros Apr 23, 2024
c5b1a2c
ci: fix e2e tests
gabor-boros Apr 23, 2024
b7f2894
build: change elemo location in the container
gabor-boros Apr 23, 2024
186d4df
refactor: extract common script
gabor-boros Apr 23, 2024
ec72bd4
feat: new bug report script
gabor-boros Apr 23, 2024
ae4b072
fix: remove docker-compose platform
gabor-boros Apr 23, 2024
f090c62
fix: replace old mailhog image
gabor-boros Apr 23, 2024
9955b14
chore: reduce integration test timeout
gabor-boros Apr 23, 2024
1cfed83
refactor: run auth client generation in docker
gabor-boros Apr 23, 2024
92cdf75
refactor: improve utility scripts
gabor-boros Apr 24, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ body:
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem. Do not include any sensitive information.
description: |
If applicable, add screenshots to help explain your problem. Do not
include any sensitive information.
value: |
![DESCRIPTION](LINK.png)
render: bash
Expand All @@ -39,7 +41,9 @@ body:
id: logs
attributes:
label: "Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
description: |
Please copy and paste any relevant log output. This will be
automatically formatted into code, so no need for backticks.
render: bash
validations:
required: false
Expand All @@ -59,16 +63,14 @@ body:
validations:
required: false
- type: textarea
id: version
id: bug-report
attributes:
label: "Version"
description: What is the affected Elemo and Go versions?
label: "Automated bug report"
description: |
Run `scripts/bug-report.sh` locally and paste its output. If the script
fails, paste that output. If it is not applicable to share the output,
paste "N/A". Do not include any sensitive information.
placeholder: |
{
"Version": "0.1.0",
"Commit": "5a21d5a",
"Date": "2024-01-01T07:48:34Z",
"GoVersion": "go1.22.2"
}
<OUTPUT>
validations:
required: true
12 changes: 0 additions & 12 deletions .github/actions/generate/action.yml

This file was deleted.

27 changes: 8 additions & 19 deletions .github/boring-cyborg.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
labelPRBasedOnFilePath:
api:
- api/**/*
- internal/controller/well_known.go
- internal/server/**/*
- internal/transport/http/**/*
- web/packages/elemo-client/**/*
auth:
- internal/auth/**/*
- internal/controller/auth.go
- internal/service/auth.go
- internal/service/client.go
- internal/service/identity_provider.go
- internal/service/session.go
- internal/service/token.go
- internal/transport/http/auth.go
build:
- .github/**/*
- build/**/*
ci:
- ci/**/*
- Makefile
configs:
- configs/**/*
- internal/config/**/*
Expand All @@ -24,13 +18,8 @@ labelPRBasedOnFilePath:
- web/**/*
legal:
- LICENSE
- web/LICENSE
- .license-decisions.yml
license:
- internal/license/**/*
- tool/generate-key/**/*
- tool/generate-license/**/*
- tool/validate-license/**/*
policy:
- assets/bundles/*
- assets/policies/**/*
- tool/key-generator/**/*
- tool/license-generator/**/*
- tool/license-validator/**/*
10 changes: 10 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ updates:
include: scope
open-pull-requests-limit: 10

# Maintain dependencies for npm
- package-ecosystem: "npm"
directory: "/web/packages/elemo-client/"
schedule:
interval: "monthly"
commit-message:
prefix: chore
include: scope
open-pull-requests-limit: 10

# Maintain dependencies for GitHub actions
- package-ecosystem: "github-actions"
directory: /
Expand Down
25 changes: 17 additions & 8 deletions .github/workflows/build-backend.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build Backend
name: Build backend

on:
push:
Expand All @@ -18,7 +18,6 @@ jobs:
- uses: actions/setup-go@v4
with:
go-version: "^1.22"
- uses: ./.github/actions/generate
- name: Go CI Lint
uses: golangci/golangci-lint-action@v3
with:
Expand All @@ -34,28 +33,39 @@ jobs:
- uses: actions/setup-go@v4
with:
go-version: "^1.22"
- uses: ./.github/actions/generate
- name: Execute unit tests
run: make test.unit
run: make test.backend.unit
- name: Stash test results
uses: actions/upload-artifact@master
with:
name: "unit-test-results"
path: .coverage.unit.out
retention-days: 7

benchmark-test:
runs-on: "ubuntu-latest"
needs:
- lint
steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v4
with:
go-version: "^1.22"
- name: Execute integration tests
run: make test.backend.bench

integration-test:
runs-on: "ubuntu-latest"
needs:
- unit-test
- benchmark-test
steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v4
with:
go-version: "^1.22"
- uses: ./.github/actions/generate
- name: Execute integration tests
run: make test.integration
run: make test.backend.integration
- name: Stash test results
uses: actions/upload-artifact@master
with:
Expand All @@ -81,12 +91,11 @@ jobs:
uses: actions/download-artifact@master
with:
name: "integration-test-results"
- uses: ./.github/actions/generate
- name: Upload test results
uses: paambaati/[email protected]
env:
CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
with:
coverageCommand: make coverage.combine
coverageCommand: make test.backend.coverage
prefix: github.com/${{github.repository}}
coverageLocations: ${{github.workspace}}/.coverage.out:gocov
57 changes: 57 additions & 0 deletions .github/workflows/build-frontend.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Build front-end

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
lint:
runs-on: "ubuntu-latest"
env:
GO111MODULE: on
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v4
with:
node-version: "20.x"
- name: Install pnpm
run: npm install -g pnpm
- name: Lint
run: make dep.frontend lint.frontend

e2e-test:
runs-on: "ubuntu-latest"
needs:
- lint
env:
CI: true
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v4
with:
node-version: "20.x"
- uses: actions/setup-go@v4
with:
go-version: "^1.22"
- name: Install dependencies
run: |
pip install jq yq
npm install -g pnpm
pnpm --prefix web dlx playwright install --with-deps
- name: Setup local env
run: |
./scripts/setup.sh
sed -i s/CI=false/CI=true/g web/.env.test.local
sed -i s/PLAYWRIGHT_HEADLESS=false/PLAYWRIGHT_HEADLESS=true/g web/.env.test.local
- name: Execute end-to-end tests
run: make dep.frontend test.frontend.e2e
- name: Stash test results
uses: actions/upload-artifact@master
with:
name: "unit-test-results"
path: web/tests/results
retention-days: 7
2 changes: 1 addition & 1 deletion .github/workflows/commit-lint.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Lint Commit Messages
name: Lint commit messages

on:
push:
Expand Down
1 change: 0 additions & 1 deletion .nvmrc

This file was deleted.

Loading
Loading