mirror of
https://github.com/Dokploy/dokploy
synced 2025-06-26 18:27:59 +00:00
Merge pull request #24 from Dokploy/docs/contributing
Docs/contributing
This commit is contained in:
3
.env.production.example
Normal file
3
.env.production.example
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
DATABASE_URL="postgres://dokploy:amukds4wi9001583845717ad2@dokploy-postgres:5432/dokploy"
|
||||||
|
PORT=3000
|
||||||
|
NODE_ENV=production
|
||||||
59
.github/workflows/pull-request.yml
vendored
59
.github/workflows/pull-request.yml
vendored
@@ -4,8 +4,14 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- canary
|
- canary
|
||||||
|
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
- canary
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build-app:
|
||||||
|
if: github.event_name == 'pull_request'
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-20.04
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
@@ -23,4 +29,53 @@ jobs:
|
|||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: pnpm install
|
run: pnpm install
|
||||||
- name: Run Build
|
- name: Run Build
|
||||||
run: pnpm build
|
run: pnpm build
|
||||||
|
|
||||||
|
|
||||||
|
build-docker-on-pr:
|
||||||
|
if: github.event_name == 'pull_request'
|
||||||
|
needs: build-app
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Check out the code
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
|
- name: Prepare .env file
|
||||||
|
run: |
|
||||||
|
cp .env.production.example .env.production
|
||||||
|
|
||||||
|
- name: Run custom Docker build script
|
||||||
|
run: |
|
||||||
|
chmod +x ./docker/build.sh
|
||||||
|
echo "Building Docker image for ${{ github.base_ref }}"
|
||||||
|
./docker/build.sh ${{ github.base_ref == 'canary' && 'canary' || '' }}
|
||||||
|
|
||||||
|
build-and-push-docker-on-push:
|
||||||
|
if: github.event_name == 'push'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Check out the code
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
|
- name: Login to Docker Hub
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Prepare .env file
|
||||||
|
run: |
|
||||||
|
cp .env.production.example .env.production
|
||||||
|
|
||||||
|
- name: Build and push Docker image using custom script
|
||||||
|
run: |
|
||||||
|
chmod +x ./docker/build.sh
|
||||||
|
chmod +x ./docker/push.sh
|
||||||
|
./docker/build.sh ${{ github.base_ref == 'canary' && 'canary' || '' }}
|
||||||
|
./docker/push.sh ${{ github.base_ref == 'canary' && 'canary' || '' }}
|
||||||
@@ -49,8 +49,12 @@ feat: add new feature
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
|
Before you start, please make the clone based on the `canary` branch, since the `main` branch is the source of truth and should always reflect the latest stable release, also the PRs will be merged to the `canary` branch.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/dokploy/dokploy.git
|
git clone https://github.com/dokploy/dokploy.git
|
||||||
cd dokploy
|
cd dokploy
|
||||||
|
|||||||
Reference in New Issue
Block a user