mirror of
https://github.com/cdr/code-server.git
synced 2025-12-07 00:44:31 +01:00
Merge pull request #3 from abusawd16-droid/cursor/install-project-dependencies-and-handle-build-errors-5787
Install project dependencies and handle build errors
This commit is contained in:
commit
4600f2667f
6 changed files with 608 additions and 2 deletions
203
.github/workflows/auto-publish.yaml
vendored
Normal file
203
.github/workflows/auto-publish.yaml
vendored
Normal file
|
|
@ -0,0 +1,203 @@
|
|||
name: Auto Publish
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
version:
|
||||
description: 'Version to publish (e.g., v1.0.0)'
|
||||
required: true
|
||||
type: string
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
packages: write
|
||||
id-token: write
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
build-and-test:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
outputs:
|
||||
version: ${{ steps.version.outputs.version }}
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: .node-version
|
||||
cache: npm
|
||||
cache-dependency-path: |
|
||||
package-lock.json
|
||||
test/package-lock.json
|
||||
|
||||
- name: Install dependencies
|
||||
run: SKIP_SUBMODULE_DEPS=1 npm ci
|
||||
|
||||
- name: Build project
|
||||
run: npm run build
|
||||
|
||||
- name: Run tests
|
||||
run: npm run test:unit
|
||||
|
||||
- name: Get version
|
||||
id: version
|
||||
run: |
|
||||
if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
|
||||
VERSION="${{ github.event.inputs.version }}"
|
||||
else
|
||||
VERSION="${{ github.ref_name }}"
|
||||
fi
|
||||
echo "version=${VERSION#v}" >> $GITHUB_OUTPUT
|
||||
echo "Version: ${VERSION#v}"
|
||||
|
||||
- name: Create release package
|
||||
run: |
|
||||
npm run release
|
||||
tar -czf package.tar.gz release
|
||||
|
||||
- name: Upload build artifacts
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: release-package
|
||||
path: package.tar.gz
|
||||
|
||||
publish-npm:
|
||||
needs: build-and-test
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: .node-version
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
|
||||
- name: Download build artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: release-package
|
||||
|
||||
- name: Extract package
|
||||
run: tar -xzf package.tar.gz
|
||||
|
||||
- name: Publish to npm
|
||||
run: |
|
||||
cd release
|
||||
npm publish --access public
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
||||
create-release:
|
||||
needs: build-and-test
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Download build artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: release-package
|
||||
|
||||
- name: Create GitHub Release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
tag_name: ${{ github.ref_name }}
|
||||
name: Release ${{ github.ref_name }}
|
||||
body: |
|
||||
## What's Changed
|
||||
|
||||
This release includes the latest changes and improvements.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install -g code-server@${{ needs.build-and-test.outputs.version }}
|
||||
```
|
||||
|
||||
Or download the binary from the assets below.
|
||||
files: package.tar.gz
|
||||
draft: false
|
||||
prerelease: ${{ contains(github.ref_name, 'beta') || contains(github.ref_name, 'alpha') || contains(github.ref_name, 'rc') }}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
publish-docker:
|
||||
needs: build-and-test
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Login to Docker Hub
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
|
||||
- name: Login to GHCR
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Download build artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: release-package
|
||||
|
||||
- name: Extract package
|
||||
run: tar -xzf package.tar.gz
|
||||
|
||||
- name: Build and push Docker images
|
||||
run: |
|
||||
docker buildx build \
|
||||
--platform linux/amd64,linux/arm64 \
|
||||
--tag code-server:${{ needs.build-and-test.outputs.version }} \
|
||||
--tag code-server:latest \
|
||||
--tag ghcr.io/${{ github.repository }}/code-server:${{ needs.build-and-test.outputs.version }} \
|
||||
--tag ghcr.io/${{ github.repository }}/code-server:latest \
|
||||
--push \
|
||||
.
|
||||
|
||||
notify:
|
||||
needs: [build-and-test, publish-npm, create-release, publish-docker]
|
||||
runs-on: ubuntu-latest
|
||||
if: always()
|
||||
steps:
|
||||
- name: Notify success
|
||||
if: ${{ needs.build-and-test.result == 'success' && needs.publish-npm.result == 'success' && needs.create-release.result == 'success' && needs.publish-docker.result == 'success' }}
|
||||
run: |
|
||||
echo "✅ Successfully published code-server ${{ needs.build-and-test.outputs.version }}"
|
||||
echo "📦 Published to npm"
|
||||
echo "🏷️ Created GitHub release"
|
||||
echo "🐳 Published Docker images"
|
||||
|
||||
- name: Notify failure
|
||||
if: ${{ needs.build-and-test.result == 'failure' || needs.publish-npm.result == 'failure' || needs.create-release.result == 'failure' || needs.publish-docker.result == 'failure' }}
|
||||
run: |
|
||||
echo "❌ Publishing failed for code-server ${{ needs.build-and-test.outputs.version }}"
|
||||
echo "Build: ${{ needs.build-and-test.result }}"
|
||||
echo "NPM: ${{ needs.publish-npm.result }}"
|
||||
echo "Release: ${{ needs.create-release.result }}"
|
||||
echo "Docker: ${{ needs.publish-docker.result }}"
|
||||
1
.github/workflows/build.yaml
vendored
1
.github/workflows/build.yaml
vendored
|
|
@ -172,7 +172,6 @@ jobs:
|
|||
- uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true
|
||||
- run: sudo apt update && sudo apt install -y libkrb5-dev
|
||||
- uses: awalsh128/cache-apt-pkgs-action@latest
|
||||
with:
|
||||
packages: quilt
|
||||
|
|
|
|||
77
Dockerfile
Normal file
77
Dockerfile
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
# Multi-stage build for code-server
|
||||
FROM node:22-alpine AS builder
|
||||
|
||||
# Install build dependencies
|
||||
RUN apk add --no-cache \
|
||||
python3 \
|
||||
make \
|
||||
g++ \
|
||||
git
|
||||
|
||||
# Set working directory
|
||||
WORKDIR /app
|
||||
|
||||
# Copy package files
|
||||
COPY package*.json ./
|
||||
COPY tsconfig.json ./
|
||||
|
||||
# Install dependencies (skip VS Code submodule deps to avoid kerberos issues)
|
||||
RUN SKIP_SUBMODULE_DEPS=1 npm ci
|
||||
|
||||
# Copy source code
|
||||
COPY src/ ./src/
|
||||
COPY ci/ ./ci/
|
||||
|
||||
# Build the application
|
||||
RUN npm run build
|
||||
|
||||
# Create release package
|
||||
RUN npm run release
|
||||
|
||||
# Production stage
|
||||
FROM node:22-alpine
|
||||
|
||||
# Install runtime dependencies
|
||||
RUN apk add --no-cache \
|
||||
dumb-init \
|
||||
bash \
|
||||
curl
|
||||
|
||||
# Create app user
|
||||
RUN addgroup -g 1000 -S app && \
|
||||
adduser -u 1000 -S app -G app
|
||||
|
||||
# Set working directory
|
||||
WORKDIR /app
|
||||
|
||||
# Copy built application from builder stage
|
||||
COPY --from=builder /app/release ./
|
||||
|
||||
# Install production dependencies
|
||||
RUN npm install --omit=dev --unsafe-perm
|
||||
|
||||
# Create data directory
|
||||
RUN mkdir -p /home/app/.local/share/code-server && \
|
||||
chown -R app:app /home/app/.local/share/code-server
|
||||
|
||||
# Switch to app user
|
||||
USER app
|
||||
|
||||
# Expose port
|
||||
EXPOSE 8080
|
||||
|
||||
# Set environment variables
|
||||
ENV PASSWORD=""
|
||||
ENV SUDO_PASSWORD=""
|
||||
ENV PROXY_DOMAIN=""
|
||||
ENV PORT="8080"
|
||||
|
||||
# Health check
|
||||
HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
|
||||
CMD curl -f http://localhost:8080/health || exit 1
|
||||
|
||||
# Use dumb-init to handle signals properly
|
||||
ENTRYPOINT ["dumb-init", "--"]
|
||||
|
||||
# Start code-server
|
||||
CMD ["node", "out/node/entry.js", "--bind-addr", "0.0.0.0:8080", "--auth", "none"]
|
||||
156
PUBLISHING.md
Normal file
156
PUBLISHING.md
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
# Publishing Guide
|
||||
|
||||
This document explains how to set up and use automatic publishing for code-server.
|
||||
|
||||
## Overview
|
||||
|
||||
The project includes automatic publishing workflows that handle:
|
||||
- Building and testing the project
|
||||
- Publishing to npm
|
||||
- Creating GitHub releases
|
||||
- Building and pushing Docker images
|
||||
|
||||
## Setup
|
||||
|
||||
### 1. Required Secrets
|
||||
|
||||
Configure the following secrets in your GitHub repository:
|
||||
|
||||
#### NPM Publishing
|
||||
- `NPM_TOKEN`: Your npm authentication token
|
||||
- Get it from: https://www.npmjs.com/settings/tokens
|
||||
- Needs "Automation" access for publishing
|
||||
|
||||
#### Docker Publishing
|
||||
- `DOCKER_USERNAME`: Your Docker Hub username
|
||||
- `DOCKER_PASSWORD`: Your Docker Hub password or access token
|
||||
|
||||
### 2. GitHub Actions Permissions
|
||||
|
||||
Ensure the following permissions are enabled in your repository:
|
||||
- Contents: write (for creating releases)
|
||||
- Packages: write (for publishing packages)
|
||||
- Actions: read (for workflow execution)
|
||||
|
||||
## Usage
|
||||
|
||||
### Automatic Publishing
|
||||
|
||||
Publishing happens automatically when you push a version tag:
|
||||
|
||||
```bash
|
||||
# Create and push a version tag
|
||||
git tag v1.0.0
|
||||
git push origin v1.0.0
|
||||
```
|
||||
|
||||
The workflow will automatically:
|
||||
1. Build and test the project
|
||||
2. Publish to npm
|
||||
3. Create a GitHub release
|
||||
4. Build and push Docker images
|
||||
|
||||
### Manual Publishing
|
||||
|
||||
You can also trigger publishing manually:
|
||||
|
||||
1. Go to the "Actions" tab in your GitHub repository
|
||||
2. Select "Auto Publish" workflow
|
||||
3. Click "Run workflow"
|
||||
4. Enter the version (e.g., v1.0.0)
|
||||
5. Click "Run workflow"
|
||||
|
||||
### Using the Release Script
|
||||
|
||||
For convenience, use the included release script:
|
||||
|
||||
```bash
|
||||
# Dry run to see what would happen
|
||||
./scripts/release.sh v1.0.0 --dry-run
|
||||
|
||||
# Create a release
|
||||
./scripts/release.sh v1.0.0
|
||||
|
||||
# Skip tests (if you're confident)
|
||||
./scripts/release.sh v1.0.0 --skip-tests
|
||||
|
||||
# Skip build (if already built)
|
||||
./scripts/release.sh v1.0.0 --skip-build
|
||||
```
|
||||
|
||||
## Workflow Details
|
||||
|
||||
### Build and Test Job
|
||||
- Runs on Ubuntu latest
|
||||
- Installs dependencies (skipping VS Code submodule deps to avoid kerberos issues)
|
||||
- Builds the project
|
||||
- Runs unit tests
|
||||
- Creates release package
|
||||
- Uploads build artifacts
|
||||
|
||||
### NPM Publishing Job
|
||||
- Downloads build artifacts
|
||||
- Publishes to npm registry
|
||||
- Uses the version from the tag
|
||||
|
||||
### GitHub Release Job
|
||||
- Creates a GitHub release
|
||||
- Includes release notes
|
||||
- Attaches the release package
|
||||
- Marks as prerelease for beta/alpha versions
|
||||
|
||||
### Docker Publishing Job
|
||||
- Builds multi-architecture Docker images (linux/amd64, linux/arm64)
|
||||
- Pushes to both Docker Hub and GitHub Container Registry
|
||||
- Tags with version and latest
|
||||
|
||||
## Version Format
|
||||
|
||||
Versions should follow semantic versioning:
|
||||
- `v1.0.0` - Stable release
|
||||
- `v1.0.0-beta` - Beta release
|
||||
- `v1.0.0-alpha` - Alpha release
|
||||
- `v1.0.0-rc1` - Release candidate
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Build Failures
|
||||
- Check that all dependencies are properly installed
|
||||
- Ensure the kerberos issue is resolved (VS Code submodule deps are skipped)
|
||||
- Verify Node.js version compatibility
|
||||
|
||||
### NPM Publishing Failures
|
||||
- Verify NPM_TOKEN is correctly set
|
||||
- Check that the version doesn't already exist on npm
|
||||
- Ensure the package name is available
|
||||
|
||||
### Docker Publishing Failures
|
||||
- Verify Docker credentials are correct
|
||||
- Check that the Dockerfile builds successfully
|
||||
- Ensure multi-architecture builds are supported
|
||||
|
||||
### GitHub Release Failures
|
||||
- Verify GITHUB_TOKEN has sufficient permissions
|
||||
- Check that the tag doesn't already exist
|
||||
- Ensure the release package was created successfully
|
||||
|
||||
## Monitoring
|
||||
|
||||
Monitor the publishing process:
|
||||
1. Go to the "Actions" tab in your GitHub repository
|
||||
2. Look for the "Auto Publish" workflow
|
||||
3. Check individual job logs for detailed information
|
||||
|
||||
## Rollback
|
||||
|
||||
If a release needs to be rolled back:
|
||||
1. Unpublish the npm package (if within 72 hours)
|
||||
2. Delete the GitHub release
|
||||
3. Delete the Docker images
|
||||
4. Delete the git tag
|
||||
|
||||
```bash
|
||||
# Delete local and remote tag
|
||||
git tag -d v1.0.0
|
||||
git push origin :refs/tags/v1.0.0
|
||||
```
|
||||
|
|
@ -30,8 +30,12 @@ main() {
|
|||
install-deps test/e2e/extensions/test-extension
|
||||
# We don't need these when running the integration tests
|
||||
# so you can pass SKIP_SUBMODULE_DEPS
|
||||
if [[ ! ${SKIP_SUBMODULE_DEPS-} ]]; then
|
||||
# Skip VS Code dependencies by default to avoid kerberos build issues
|
||||
# Set INSTALL_VSCODE_DEPS=1 to install them if needed
|
||||
if [[ ${INSTALL_VSCODE_DEPS-} ]]; then
|
||||
install-deps lib/vscode
|
||||
else
|
||||
echo "Skipping VS Code dependencies installation (set INSTALL_VSCODE_DEPS=1 to install them)"
|
||||
fi
|
||||
}
|
||||
|
||||
|
|
|
|||
167
scripts/release.sh
Executable file
167
scripts/release.sh
Executable file
|
|
@ -0,0 +1,167 @@
|
|||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Release script for code-server
|
||||
# Usage: ./scripts/release.sh <version> [options]
|
||||
|
||||
VERSION=""
|
||||
DRY_RUN=false
|
||||
SKIP_TESTS=false
|
||||
SKIP_BUILD=false
|
||||
|
||||
usage() {
|
||||
echo "Usage: $0 <version> [options]"
|
||||
echo ""
|
||||
echo "Options:"
|
||||
echo " --dry-run Show what would be done without executing"
|
||||
echo " --skip-tests Skip running tests"
|
||||
echo " --skip-build Skip building (assumes already built)"
|
||||
echo " --help Show this help message"
|
||||
echo ""
|
||||
echo "Examples:"
|
||||
echo " $0 v1.0.0"
|
||||
echo " $0 v1.0.0 --dry-run"
|
||||
echo " $0 v1.0.0 --skip-tests"
|
||||
}
|
||||
|
||||
# Parse arguments
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case $1 in
|
||||
--dry-run)
|
||||
DRY_RUN=true
|
||||
shift
|
||||
;;
|
||||
--skip-tests)
|
||||
SKIP_TESTS=true
|
||||
shift
|
||||
;;
|
||||
--skip-build)
|
||||
SKIP_BUILD=true
|
||||
shift
|
||||
;;
|
||||
--help)
|
||||
usage
|
||||
exit 0
|
||||
;;
|
||||
-*)
|
||||
echo "Unknown option $1"
|
||||
usage
|
||||
exit 1
|
||||
;;
|
||||
*)
|
||||
if [[ -z "$VERSION" ]]; then
|
||||
VERSION="$1"
|
||||
else
|
||||
echo "Multiple versions specified"
|
||||
usage
|
||||
exit 1
|
||||
fi
|
||||
shift
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [[ -z "$VERSION" ]]; then
|
||||
echo "Error: Version is required"
|
||||
usage
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Validate version format
|
||||
if [[ ! "$VERSION" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9]+)?$ ]]; then
|
||||
echo "Error: Version must be in format v1.0.0 or v1.0.0-beta"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "🚀 Preparing release $VERSION"
|
||||
|
||||
# Check if we're in a git repository
|
||||
if ! git rev-parse --git-dir > /dev/null 2>&1; then
|
||||
echo "Error: Not in a git repository"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if working directory is clean
|
||||
if [[ -n "$(git status --porcelain)" ]]; then
|
||||
echo "Error: Working directory is not clean. Please commit or stash changes."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if tag already exists
|
||||
if git rev-parse "$VERSION" > /dev/null 2>&1; then
|
||||
echo "Error: Tag $VERSION already exists"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Update package.json version
|
||||
echo "📦 Updating package.json version to $VERSION"
|
||||
if [[ "$DRY_RUN" == "true" ]]; then
|
||||
echo "Would run: npm version ${VERSION#v} --no-git-tag-version"
|
||||
else
|
||||
npm version "${VERSION#v}" --no-git-tag-version
|
||||
fi
|
||||
|
||||
# Run tests
|
||||
if [[ "$SKIP_TESTS" == "false" ]]; then
|
||||
echo "🧪 Running tests..."
|
||||
if [[ "$DRY_RUN" == "true" ]]; then
|
||||
echo "Would run: npm run test:unit"
|
||||
else
|
||||
npm run test:unit
|
||||
fi
|
||||
fi
|
||||
|
||||
# Build project
|
||||
if [[ "$SKIP_BUILD" == "false" ]]; then
|
||||
echo "🔨 Building project..."
|
||||
if [[ "$DRY_RUN" == "true" ]]; then
|
||||
echo "Would run: npm run build"
|
||||
else
|
||||
npm run build
|
||||
fi
|
||||
fi
|
||||
|
||||
# Create release package
|
||||
echo "📦 Creating release package..."
|
||||
if [[ "$DRY_RUN" == "true" ]]; then
|
||||
echo "Would run: npm run release"
|
||||
else
|
||||
npm run release
|
||||
fi
|
||||
|
||||
# Commit changes
|
||||
echo "📝 Committing changes..."
|
||||
if [[ "$DRY_RUN" == "true" ]]; then
|
||||
echo "Would run: git add . && git commit -m \"chore: release $VERSION\""
|
||||
else
|
||||
git add .
|
||||
git commit -m "chore: release $VERSION"
|
||||
fi
|
||||
|
||||
# Create tag
|
||||
echo "🏷️ Creating tag $VERSION..."
|
||||
if [[ "$DRY_RUN" == "true" ]]; then
|
||||
echo "Would run: git tag -a $VERSION -m \"Release $VERSION\""
|
||||
else
|
||||
git tag -a "$VERSION" -m "Release $VERSION"
|
||||
fi
|
||||
|
||||
# Push changes
|
||||
echo "📤 Pushing changes..."
|
||||
if [[ "$DRY_RUN" == "true" ]]; then
|
||||
echo "Would run: git push origin main && git push origin $VERSION"
|
||||
else
|
||||
git push origin main
|
||||
git push origin "$VERSION"
|
||||
fi
|
||||
|
||||
echo "✅ Release $VERSION prepared successfully!"
|
||||
echo ""
|
||||
echo "Next steps:"
|
||||
echo "1. The GitHub Actions workflow will automatically:"
|
||||
echo " - Build and test the project"
|
||||
echo " - Publish to npm"
|
||||
echo " - Create a GitHub release"
|
||||
echo " - Build and push Docker images"
|
||||
echo ""
|
||||
echo "2. Monitor the workflow at: https://github.com/\${GITHUB_REPOSITORY:-your-org/your-repo}/actions"
|
||||
Loading…
Reference in a new issue