diff --git a/.github/workflows/manual-release.yml b/.github/workflows/manual-release.yml index d794655..44094ac 100644 --- a/.github/workflows/manual-release.yml +++ b/.github/workflows/manual-release.yml @@ -13,6 +13,7 @@ jobs: name: Build for ${{ matrix.os }} runs-on: ${{ matrix.os }} strategy: + fail-fast: false matrix: include: - os: ubuntu-latest @@ -169,27 +170,12 @@ jobs: with: path: artifacts - - name: Read RELEASE-GUIDE.md - id: release_guide - run: | - delimiter="$(openssl rand -hex 8)" - echo "RELEASE_GUIDE<<${delimiter}" >> $GITHUB_OUTPUT - cat RELEASE-GUIDE.md >> $GITHUB_OUTPUT - echo "${delimiter}" >> $GITHUB_OUTPUT - - name: Create Release uses: softprops/action-gh-release@v1 with: tag_name: ${{ github.event.inputs.tag }} name: ADJ Valet ${{ github.event.inputs.tag }} - body: | - ## What's Changed - - This release includes improvements to stability and performance. - - --- - - ${{ steps.release_guide.outputs.RELEASE_GUIDE }} + generate_release_notes: true files: artifacts/**/* draft: false prerelease: false diff --git a/.gitignore b/.gitignore index 1928657..2d3d0bf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -# OS specific files +# OS generated files .DS_Store .DS_Store? ._* @@ -6,55 +6,74 @@ .Trashes ehthumbs.db Thumbs.db +Desktop.ini -# IDEs and editors +# IDE and Editor files .vscode/ .idea/ -*.swp -*.swo -*~ .zed/ -.claude/ +.vim/ +.netrwhist +*~ +.swp +.swo +*.tmp -# Environment variables +# Environment and configuration .env .env.local .env.development.local .env.test.local .env.production.local +.env/ -# Project specific -adj/ -test-adj/ -CLAUDE.md +# Dependencies +node_modules/ +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* +.pnpm-debug.log* -# Rust backend -/backend/target/ -/backend/Cargo.lock -/backend/.adj-valet-port -/backend/*.log -/backend/test* - -# Node.js frontend -/adj-valet-front/node_modules/ -/adj-valet-front/dist/ -/adj-valet-front/build/ -/adj-valet-front/.vite/ -/adj-valet-front/npm-debug.log* -/adj-valet-front/yarn-debug.log* -/adj-valet-front/yarn-error.log* -/adj-valet-front/pnpm-debug.log* -/adj-valet-front/lerna-debug.log* -/adj-valet-front/.eslintcache -/adj-valet-front/frontend.log -/adj-valet-front/frontend_test.log - -# Coverage reports +# Frontend build artifacts +dist/ +build/ +.vite/ +.next/ +.nuxt/ +.cache/ coverage/ -*.lcov -.nyc_output + +# Rust/Cargo +target/ +Cargo.lock +*.pdb + +# Python +__pycache__/ +*.py[cod] +*$py.class +*.so +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST # Logs +logs/ *.log npm-debug.log* yarn-debug.log* @@ -63,20 +82,83 @@ lerna-debug.log* .pnpm-debug.log* # Runtime data -pids +pids/ *.pid *.seed *.pid.lock -# Temporary files -*.tmp -*.temp +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov/ + +# Coverage directory used by tools like istanbul +coverage/ +*.lcov + +# nyc test coverage +.nyc_output/ + +# Dependency directories +jspm_packages/ + +# TypeScript cache +*.tsbuildinfo + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional stylelint cache +.stylelintcache + +# Microbundle cache +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# parcel-bundler cache (https://parceljs.org/) +.parcel-cache/ + +# Stores VSCode versions used for testing VSCode extensions +.vscode-test + +# Temporary folders +tmp/ +temp/ + +# Archives +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip # Nix +*.nix result result-* -# Backup files -*.bak -*.backup -*~ +# Project specific +/backend/.venew_jsonnew_json +/release/ + +# Claude AI +CLAUDE.md +.claude/ + +# Port files +backend/.adj-valet-port diff --git a/README.md b/README.md index 40c9db4..56e6667 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,21 @@ ADJ Valet is a web-based configuration management tool designed for the Hyperloo ## Quick Start -### Option 1: Using the Run Script (Recommended) +### Option 1: Download Pre-built Release (Easiest) + +1. **Download** the latest release for your platform from [Releases](https://github.com/HyperloopUPV-H8/adj-valet/releases) + - Windows (Intel/AMD): `adj-valet-x86_64-pc-windows-msvc.zip` + - Windows (ARM): `adj-valet-aarch64-pc-windows-msvc.zip` + - macOS (Intel): `adj-valet-x86_64-apple-darwin.tar.gz` + - macOS (Apple Silicon): `adj-valet-aarch64-apple-darwin.tar.gz` + - Linux: `adj-valet-x86_64-unknown-linux-gnu.tar.gz` + +2. **Extract** the archive +3. **Run** the startup script: + - Windows: Double-click `start.bat` + - macOS/Linux: Double-click `start.sh` or run `./start.sh` + +### Option 2: Using the Run Script (Development) ```bash # Clone the repository @@ -40,7 +54,7 @@ cd adj-valet ./run.sh frontend # Frontend only ``` -### Option 2: Using Nix Shell +### Option 3: Using Nix Shell ```bash # Enter the Nix development shell