Skip to content

Commit 5e09ac0

Browse files
authored
update packages
1 parent ed336b5 commit 5e09ac0

9 files changed

Lines changed: 147 additions & 693 deletions

File tree

Makefile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Makefile for devbox CLI tool
2-
31
# Go parameters
42
GOCMD=go
53
GOBUILD=$(GOCMD) build

README.md

Lines changed: 1 addition & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,7 @@ devbox creates isolated development environments, contained in a project's Docke
2323
```bash
2424
# Using the install script
2525
curl -fsSL https://raw.githubusercontent.com/itzCozi/devbox/main/install.sh | bash
26-
27-
# OR
28-
29-
# Clone the repository
30-
git clone https://github.com/itzCozi/devbox.git
31-
cd devbox
32-
33-
# Build the binary
34-
make build
35-
36-
# Install (optional)
37-
sudo make install
26+
# Or manually: https://devbox.ar0.eu/guides/install/#manual-build-from-source
3827
```
3928

4029
## Quick Start
@@ -64,24 +53,6 @@ sudo make install
6453
devbox destroy my-project
6554
```
6655

67-
## Configuration
68-
69-
devbox uses a simple `devbox.json` file to configure your environment:
70-
71-
```json
72-
{
73-
"name": "my-project",
74-
"base_image": "ubuntu:22.04",
75-
"setup_commands": [
76-
"apt update && apt install -y python3 python3-pip",
77-
"pip3 install flask requests"
78-
],
79-
"environment": {
80-
"PYTHON_ENV": "development"
81-
}
82-
}
83-
```
84-
8556
## Commands
8657

8758
- `devbox init <name>` - Initialize a new development environment
@@ -99,70 +70,6 @@ For detailed documentation, guides, and examples, visit:
9970

10071
**📖 [devbox.ar0.eu](https://devbox.ar0.eu)**
10172

102-
## Development
103-
104-
### CI/CD Pipeline
105-
106-
This project uses GitHub Actions for continuous integration and deployment:
107-
108-
- **CI Pipeline** (`.github/workflows/ci.yml`):
109-
- Runs tests with race detection
110-
- Checks code formatting with `gofmt`
111-
- Performs static analysis with `go vet`, `staticcheck`, and `golint`
112-
- Builds binaries for multiple platforms (Linux, Windows, macOS)
113-
- Uploads build artifacts
114-
115-
- **Code Quality** (`.github/workflows/quality.yml`):
116-
- Security scanning with `gosec` and `govulncheck`
117-
- Code quality checks with `golangci-lint`
118-
- Test coverage reporting (minimum 50% threshold)
119-
- Cyclomatic complexity analysis
120-
121-
- **Release Pipeline** (`.github/workflows/release.yml`):
122-
- Builds release binaries for all supported platforms
123-
- Creates compressed archives for distribution
124-
- Uploads assets to GitHub releases
125-
126-
- **Documentation** (`.github/workflows/docs.yml`):
127-
- Builds and deploys documentation to GitHub Pages
128-
- Triggered on changes to the `docs/` directory
129-
130-
### Local Development
131-
132-
Use the following Make targets for local development:
133-
134-
```bash
135-
# Run all quality checks (like CI)
136-
make ci
137-
138-
# Format code
139-
make fmt
140-
141-
# Run tests with coverage
142-
make test-coverage
143-
144-
# Run security checks
145-
make security
146-
147-
# Check code formatting
148-
make check-fmt
149-
150-
# Run linter
151-
make lint
152-
```
153-
154-
### Code Quality Standards
155-
156-
- Code must be formatted with `gofmt`
157-
- All code must pass `golangci-lint` checks
158-
- Minimum test coverage of 50%
159-
- Security vulnerabilities must be addressed
160-
- Cyclomatic complexity should be kept under 15
161-
162-
## Contributing
163-
164-
Contributions are welcome! Please feel free to submit a Pull Request.
165-
16673
## License
16774

16875
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

docs/astro.config.mjs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export default defineConfig({
1010
starlight({
1111
title: 'devbox',
1212
description: 'Isolated development environments using Docker containers',
13-
favicon: './src/assets/logo.svg',
13+
favicon: '/src/assets/logo.svg',
1414
logo: {
1515
replacesTitle: true,
1616
light: './src/assets/logo-dark.png',
@@ -29,9 +29,8 @@ export default defineConfig({
2929
{
3030
label: 'Getting Started',
3131
items: [
32-
{ label: 'Introduction', slug: 'index' },
33-
{ label: 'Installation', slug: 'guides/install' },
3432
{ label: 'Quick Start', slug: 'guides/intro' },
33+
{ label: 'Installation', slug: 'guides/install' },
3534
],
3635
},
3736
{

0 commit comments

Comments
 (0)