Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
107 changes: 107 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
name: Bug Report
description: Report a bug in localup
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug! Please fill out the sections below to help us reproduce and fix the issue.

- type: input
id: version
attributes:
label: localup version
description: Run `localup --version` to get this
placeholder: "0.1.9"
validations:
required: true

- type: dropdown
id: os
attributes:
label: Operating System
options:
- macOS (Apple Silicon)
- macOS (Intel)
- Linux (x86_64)
- Linux (ARM64)
- Windows (x86_64)
- Other
validations:
required: true

- type: dropdown
id: protocol
attributes:
label: Protocol
description: Which tunnel protocol are you using?
options:
- HTTP
- HTTPS
- TCP
- TLS/SNI
- Not applicable
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: A clear description of the bug
placeholder: What happened? What did you expect to happen?
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: How can we reproduce this issue?
placeholder: |
1. Start relay with `localup relay --http-addr 0.0.0.0:18080`
2. Create tunnel with `localup --port 3000 --protocol http`
3. Send request to tunnel URL
4. See error...
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs
description: |
Relevant log output. Run with `--log-level debug` for verbose logs.
render: shell

- type: textarea
id: config
attributes:
label: Configuration
description: |
Any relevant configuration (relay flags, tunnel flags, environment variables).
Make sure to redact any secrets or tokens.
render: shell

- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context, screenshots, or information about the problem.
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Feature Request
description: Suggest a new feature or improvement
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a feature! Please describe what you'd like and why.

- type: textarea
id: problem
attributes:
label: Problem
description: What problem does this feature solve? What pain point are you experiencing?
placeholder: "I'm always frustrated when..."
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: How would you like this to work? Be as specific as possible.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: What alternative solutions or workarounds have you considered?

- type: dropdown
id: area
attributes:
label: Area
description: Which part of localup does this relate to?
options:
- CLI
- Client Library (Rust)
- Relay / Exit Node
- HTTP/HTTPS Tunnels
- TCP Tunnels
- TLS/SNI Tunnels
- Authentication / JWT
- Dashboard / Web UI
- Desktop App
- Node.js SDK
- Documentation
- Other
validations:
required: true

- type: dropdown
id: importance
attributes:
label: Importance
description: How important is this feature to you?
options:
- Nice to have
- Important - impacts my workflow
- Critical - blocking my use case

- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context, mockups, or examples that help explain the feature.
39 changes: 39 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Summary

<!-- Brief description of what this PR does and why -->

## Changes

<!-- Bullet list of key changes -->

-

## Related Issues

<!-- Link any related issues: Closes #123, Fixes #456 -->

## Type of Change

- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation update
- [ ] Refactoring (no functional changes)
- [ ] CI/CD or build changes

## Checklist

- [ ] `cargo fmt --all -- --check` passes
- [ ] `cargo clippy --all-targets --all-features -- -D warnings` passes
- [ ] `cargo test` passes
- [ ] I have added tests for my changes
- [ ] I have updated documentation as needed
- [ ] My changes don't introduce new warnings

## Test Plan

<!-- How did you test these changes? Include steps to reproduce or verify. -->

## Screenshots / Logs

<!-- If applicable, add screenshots or log output -->
40 changes: 40 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,16 @@ jobs:
name: webapps-ci
path: webapps/

- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y libgtk-3-dev libglib2.0-dev libsoup-3.0-dev libjavascriptcoregtk-4.1-dev libwebkit2gtk-4.1-dev

- name: Install Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
Expand Down Expand Up @@ -122,6 +132,16 @@ jobs:
name: webapps-ci
path: webapps/

- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y libgtk-3-dev libglib2.0-dev libsoup-3.0-dev libjavascriptcoregtk-4.1-dev libwebkit2gtk-4.1-dev

- name: Install Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
Expand Down Expand Up @@ -156,6 +176,16 @@ jobs:
name: webapps-ci
path: webapps/

- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y libgtk-3-dev libglib2.0-dev libsoup-3.0-dev libjavascriptcoregtk-4.1-dev libwebkit2gtk-4.1-dev

- name: Install Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
Expand Down Expand Up @@ -186,6 +216,16 @@ jobs:
name: webapps-ci
path: webapps/

- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y libgtk-3-dev libglib2.0-dev libsoup-3.0-dev libjavascriptcoregtk-4.1-dev libwebkit2gtk-4.1-dev

- name: Install Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
/target
*.db
*.db-journal
*.db-wal
*.db-shm
node_modules
.vscode

Expand Down
Loading
Loading