-
Notifications
You must be signed in to change notification settings - Fork 12
chore: add missing project infrastructure (CI, templates, .gitignore) #1
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
Closed
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
bb7c772
chore: add root .gitignore
gofenix affde16
ci: add GitHub Actions workflow for lint, typecheck, and test
gofenix 5f6d156
docs: add bug report issue template
gofenix 0c119a5
docs: add feature request issue template
gofenix b522035
docs: add pull request template
gofenix File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| name: Bug Report | ||
| description: Report a bug to help us improve OpenGUI | ||
| title: "[Bug]: " | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Bug Description | ||
| description: A clear and concise description of what the bug is. | ||
| placeholder: Tell us what happened... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduction | ||
| attributes: | ||
| label: Steps to Reproduce | ||
| description: Steps to reproduce the behavior. | ||
| placeholder: | | ||
| 1. Go to '...' | ||
| 2. Click on '...' | ||
| 3. Scroll down to '...' | ||
| 4. See error | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: Expected Behavior | ||
| description: What you expected to happen. | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: component | ||
| attributes: | ||
| label: Component | ||
| description: Which part of OpenGUI is affected? | ||
| options: | ||
| - Server (Backend) | ||
| - Android Client | ||
| - Both | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Version | ||
| description: OpenGUI version or commit hash. | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant Log Output | ||
| description: Please copy and paste any relevant log output. | ||
| render: shell |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| name: Feature Request | ||
| description: Suggest an idea for OpenGUI | ||
| title: "[Feature]: " | ||
| labels: ["enhancement"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to suggest a feature! | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: Problem Statement | ||
| description: Is your feature request related to a problem? Please describe. | ||
| placeholder: I'm always frustrated when... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: Proposed Solution | ||
| description: Describe the solution you'd like. | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: component | ||
| attributes: | ||
| label: Component | ||
| description: Which part would this feature affect? | ||
| options: | ||
| - Server (Backend) | ||
| - Android Client | ||
| - Both | ||
| - Documentation | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives Considered | ||
| description: Describe any alternative solutions you've considered. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| ## Description | ||
|
|
||
| <!-- Provide a brief description of the changes in this PR --> | ||
|
|
||
| ## Type of Change | ||
|
|
||
| <!-- Check the relevant box(es) --> | ||
|
|
||
| - [ ] 🐛 Bug fix | ||
| - [ ] ✨ New feature | ||
| - [ ] 🔧 Refactor | ||
| - [ ] 📝 Documentation update | ||
| - [ ] 🧪 Test update | ||
| - [ ] 🔨 Chore | ||
|
|
||
| ## Related Issue | ||
|
|
||
| <!-- Link the related issue, e.g., Fixes #123 --> | ||
|
|
||
| Fixes # | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] I have followed the project's code style (run `pnpm format-and-lint:fix`) | ||
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||
| - [ ] I have updated the documentation accordingly | ||
| - [ ] I have run the server locally and verified the changes work | ||
| - [ ] My commits follow the [Conventional Commits](https://www.conventionalcommits.org/) format |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| jobs: | ||
| lint: | ||
| name: Lint & Format | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: pnpm/action-setup@v4 | ||
| with: | ||
| version: 10.27.0 | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "22" | ||
| cache: "pnpm" | ||
| cache-dependency-path: server/pnpm-lock.yaml | ||
| - run: cd server && pnpm install --frozen-lockfile | ||
| - run: cd server && pnpm format-and-lint | ||
|
|
||
| typecheck: | ||
| name: Type Check | ||
| runs-on: ubuntu-latest | ||
| needs: lint | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: pnpm/action-setup@v4 | ||
| with: | ||
| version: 10.27.0 | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "22" | ||
| cache: "pnpm" | ||
| cache-dependency-path: server/pnpm-lock.yaml | ||
| - run: cd server && pnpm install --frozen-lockfile | ||
| - run: cd server/packages/database && pnpm prisma generate | ||
| - run: cd server && pnpm build | ||
|
|
||
| test: | ||
| name: Test | ||
| runs-on: ubuntu-latest | ||
| needs: lint | ||
| services: | ||
| postgres: | ||
| image: postgres:16 | ||
| env: | ||
| POSTGRES_USER: opengui | ||
| POSTGRES_PASSWORD: opengui | ||
| POSTGRES_DB: opengui | ||
| ports: | ||
| - "5432:5432" | ||
| options: >- | ||
| --health-cmd pg_isready | ||
| --health-interval 10s | ||
| --health-timeout 5s | ||
| --health-retries 5 | ||
| redis: | ||
| image: redis:7 | ||
| ports: | ||
| - "6379:6379" | ||
| options: >- | ||
| --health-cmd "redis-cli ping" | ||
| --health-interval 10s | ||
| --health-timeout 5s | ||
| --health-retries 5 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: pnpm/action-setup@v4 | ||
| with: | ||
| version: 10.27.0 | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "22" | ||
| cache: "pnpm" | ||
| cache-dependency-path: server/pnpm-lock.yaml | ||
| - run: cd server && pnpm install --frozen-lockfile | ||
| - run: cd server/packages/database && pnpm prisma generate | ||
| - run: cd server/apps/backend && pnpm test | ||
| env: | ||
| DATABASE_URL: postgresql://opengui:opengui@localhost:5432/opengui | ||
| REDIS_HOST: localhost | ||
| REDIS_PORT: 6379 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # OS | ||
| .DS_Store | ||
| Thumbs.db | ||
| *.log | ||
|
|
||
| # IDE | ||
| .idea/ | ||
| .vscode/ | ||
| *.swp | ||
| *.swo | ||
| *~ | ||
|
|
||
| # Node | ||
| node_modules/ | ||
| .pnp | ||
| .pnp.js | ||
|
|
||
| # Build | ||
| dist/ | ||
| build/ | ||
| .next/ | ||
| *.tsbuildinfo | ||
|
|
||
| # Environment | ||
| .env | ||
| .env.local | ||
| .env.*.local | ||
|
|
||
| # Misc | ||
| *.tgz | ||
| *.tar.gz | ||
| coverage/ | ||
| .nyc_output/ |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pnpm prisma generateis run withoutDATABASE_URLin the environment, butserver/packages/database/prisma.config.tscallsenv("DATABASE_URL")during Prisma config loading. That makes thetypecheckjob fail beforepnpm buildstarts (and the same pattern appears intestbeforepnpm test), so this CI workflow can fail on valid changes.Useful? React with 👍 / 👎.