OneDev

https://docs.onedev.io/
Admin
OneDev is an all-in-one DevOps platform that provides Git repository management, CI/CD pipelines,...
Tokens:89,381
Snippets:943
Trust Score:8.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Prompt: install Node.js and create Next.js project

Source: https://docs.onedev.io/tutorials/workspace/working-with-workspaces

Example prompt that instructs the coding agent to install Node.js via nvm and create a Next.js project. Use within the workspace terminal. The minimal OpenCode image does not include Node.js, so a fresh install is required.

```plaintext
Install Node.js via nvm and create an example Next.js project
```

--------------------------------

### Configure TOD interactively

Source: https://docs.onedev.io/tutorials/ai/working-with-tod-and-skills

Starts the interactive setup that asks for the OneDev server URL and a personal access token.

```bash
tod config set
```

--------------------------------

### Start OneDev with Docker

Source: https://docs.onedev.io/tutorials/code/repo-mirror

Run the OneDev server container with necessary volume mounts and port mappings to begin the setup process.

```bash
$ docker run -t --rm -v /var/run/docker.sock:/var/run/docker.sock -v $(pwd)/onedev:/opt/onedev -p 6610:6610 -p 6611:6611 1dev/server
```

--------------------------------

### Install TOD on macOS, Linux, or FreeBSD

Source: https://docs.onedev.io/tutorials/ai/working-with-tod-and-skills

Downloads and runs the installation script for TOD. The installer detects the operating system and CPU architecture, then places the 'tod' binary on PATH.

```bash
curl -fsSL https://code.onedev.io/onedev/tod/~raw/main/install.sh | bash
```

--------------------------------

### Install and Configure OneDev with Let's Encrypt on Kubernetes

Source: https://docs.onedev.io/tutorials/security/letsencrypt-with-k8s

Set up ingress-nginx and cert-manager with required leader election setting for Autopilot, get the Nginx controller's external IP, deploy OneDev with Let's Encrypt TLS, and enable SSH access via TCP forwarding.

```shell
$ helm install ingress-nginx ingress-nginx --repo https://kubernetes.github.io/ingress-nginx --namespace ingress-nginx --create-namespace  

$ helm install cert-manager cert-manager --repo https://charts.jetstack.io --namespace cert-manager --create-namespace --set crds.enabled=true --set global.leaderElection.namespace=cert-manager  


```

```shell
$ kubectl get service ingress-nginx-controller -n ingress-nginx
```

```shell
$ helm install onedev onedev --repo https://code.onedev.io/onedev/~helm --namespace onedev --create-namespace --set ingress.enabled=true --set ingress.controller=nginx --set ingress.className=nginx --set ingress.host=<OneDev DNS name> --set ingress.tls.enabled=true --set ingress.tls.acme.enabled=true --set ingress.tls.acme.email=<your email address> --set ingress.tls.acme.production=true  


```

```shell
helm upgrade onedev onedev --repo https://code.onedev.io/onedev/~helm -n onedev --set ssh.enabled=true --reuse-values  

helm upgrade ingress-nginx ingress-nginx --repo https://kubernetes.github.io/ingress-nginx -n ingress-nginx --set tcp.22=onedev/onedev:ssh --reuse-values  


```

--------------------------------

### Start test OneDev instance with Docker

Source: https://docs.onedev.io/tutorials/security/oauth-with-office365

Run this command to start a test OneDev instance for the Office 365 mail provider setup. It mounts the current directory's onedev folder and the Docker socket, and exposes ports 6610 and 6611.

```bash
$ docker run -it --rm -v $(pwd)/onedev:/opt/onedev -v /var/run/docker.sock:/var/run/docker.sock -p 6610:6610 -p 6611:6611 1dev/server:7.4.8
```

--------------------------------

### Install QEMU with binfmt

Source: https://docs.onedev.io/tutorials/cicd/multi-arch-docker-image

Run this command on the machine running OneDev server or agent (or host machine if OneDev runs inside a container) to install QEMU emulation. Docker Desktop normally includes emulation, so this is only needed on Linux hosts that require it.

```bash
docker run --privileged --rm tonistiigi/binfmt --install all  
```

--------------------------------

### Install TOD on Windows PowerShell

Source: https://docs.onedev.io/tutorials/ai/working-with-tod-and-skills

Downloads and runs the installation script for TOD on Windows. The installer detects the operating system and CPU architecture, then places the 'tod' binary on PATH.

```powershell
irm https://code.onedev.io/onedev/tod/~raw/main/install.ps1 | iex
```

--------------------------------

### Backup database from command line

Source: https://docs.onedev.io/administration-guide/backup-restore

Run this command from the OneDev installation directory to create a database backup. Replace /path/to/backup.zip with the desired backup file path. For container or Kubernetes deployments, run inside the container where the installation directory is /opt/onedev.

```bash
bin/backup-db.(sh|bat) /path/to/backup.zip
```

--------------------------------

### Build promotion example in .onedev-buildspec.yml

Source: https://docs.onedev.io/tutorials/cicd/build-promotion

Save as `.onedev-buildspec.yml`. The `Build` job publishes `app.txt` containing its build number; the `Deploy` job depends on `Build`, retrieves that artifact, and prints its contents. The example does not deploy to an external system.

```yaml
version: 53  

jobs:  

- name: Build  

  steps:  

  - !CommandStep  

    name: Build application  

    runInContainer: true  

    image: alpine:3.20  

    interpreter: !PosixInterpreter  

      shell: sh  

      commands: echo @build_number@ > app.txt  

    useTTY: false  

    runAs: '0:0'  

    condition: SUCCESSFUL  

  - !PublishArtifactStep  

    name: Publish application  

    artifacts: app.txt  

    condition: SUCCESSFUL  

  retryCondition: never  

  maxRetries: 3  

  retryDelay: 30  

  timeout: 3600  

- name: Deploy  

  steps:  

  - !CommandStep  

    name: Verify promoted artifact  

    runInContainer: true  

    image: alpine:3.20  

    interpreter: !PosixInterpreter  

      shell: sh  

      commands: cat app.txt  

    useTTY: false  

    runAs: '0:0'  

    condition: SUCCESSFUL  

  jobDependencies:  

  - jobName: Build  

    requireSuccessful: true  

    artifacts: '**'  

  retryCondition: never  

  maxRetries: 3  

  retryDelay: 30  

  timeout: 3600  
```

--------------------------------

### Install package from OneDev PyPI with pip

Source: https://docs.onedev.io/tutorials/package/working-with-pypi

Use the simple endpoint to install a specific package version. Replace <project-path>, <package-name>, and <version> with your values. Authenticate with an account or token that has package read permission.

```bash
python3 -m pip install --index-url https://onedev.example.com/<project-path>/~pypi/simple <package-name>==<version>  

```

--------------------------------

### Install TOD skills with npx skills add

Source: https://docs.onedev.io/tutorials/ai/working-with-tod-and-skills

Installs all TOD skills from the OneDev repository. The installer detects supported coding agents and lets you choose where the skills should be available.

```bash
npx skills add https://code.onedev.io/onedev/tod.git  
```

--------------------------------

### Build Python distribution with build and twine

Source: https://docs.onedev.io/tutorials/package/working-with-pypi

Install the build and twine packages, then build your distribution. This is the first step before uploading to the OneDev PyPI repository.

```bash
python3 -m pip install build twine  

python3 -m build  

```

--------------------------------

### TOD CLI examples for issues, pull requests, builds, and CI/CD

Source: https://docs.onedev.io/tutorials/ai/working-with-tod-and-skills

A set of TOD commands for common tasks: listing open issues assigned to you, checking out a pull request, inspecting a failed build, running the ci job against local changes, and validating the CI/CD spec. Note that for a local build, TOD creates a temporary commit from current tracked changes, pushes it to a dedicated temporary ref, starts the job, and streams the log back to the terminal.

```shell
# Find open issues assigned to you  

tod issue list --query '"Assignees" is me and "State" is "Open"'  

  

# Check out a pull request  

tod pr checkout PROJ-123  

  

# Inspect a failed build  

tod build get PROJ-456  

tod build get-log PROJ-456  

  

# Run the ci job against uncommitted local changes  

tod build run --local ci  

  

# Validate and upgrade the CI/CD spec  

tod build check-spec  
```

--------------------------------

### Start PostgreSQL container

Source: https://docs.onedev.io/tutorials/clustering/run-as-docker

Runs a PostgreSQL 15.4 container with a volume for data persistence, sets the database name, user, and password, and exposes port 5432.

```bash
docker run --rm -v $(pwd)/postgresql:/var/lib/postgresql/data -e POSTGRES_DB=onedev -e POSTGRES_USER=onedev -e POSTGRES_PASSWORD=changeit -p 5432:5432 postgres:15.4  
```

--------------------------------

### Set TOD server URL and access token for scripts

Source: https://docs.onedev.io/tutorials/ai/working-with-tod-and-skills

Sets the server URL and access token directly for scripting. These commands are alternatives to the interactive setup.

```bash
tod config set server-url https://onedev.example.com
```

```bash
tod config set access-token your-personal-access-token
```

--------------------------------

### Generate example file in job1

Source: https://docs.onedev.io/tutorials/cicd/pass-job-artifacts

Creates an output directory and writes a message file containing 'tutorial-artifact'. Used in an Execute Commands step in job1 with a POSIX shell and an image such as alpine:3.22.

```shell
mkdir -p output  

echo tutorial-artifact > output/message.txt  

```

--------------------------------

### Docker job build spec for failure-investigation

Source: https://docs.onedev.io/tutorials/cicd/assign-build-failure-investigator

This build spec defines a job named 'failure-investigation' that runs a command step with 'exit 1' to deliberately fail the build. It includes a post-build action to create an issue with the built-in scripts for determining the investigator and getting the build number. The example includes standard issue fields; if your installation defines additional fields, configure them in the action too, as build-spec validation reports missing fields.

```yaml
version: 53

jobs:

- name: failure-investigation

  steps:

  - !CommandStep

    name: Test application

    runInContainer: true

    image: alpine:3.20

    interpreter: !PosixInterpreter

      shell: sh

      commands: exit 1

    runAs: '0:0'

    useTTY: false

    condition: SUCCESSFUL

  postBuildActions:

  - !CreateIssueAction

    condition: failed

    issueTitle: 'Investigate failure of build #@build_number@'

    issueDescription: 'Investigate the failed tutorial build.'

    issueConfidential: false

    issueFields:

    - name: Type

      valueProvider: !SpecifiedValue

        value: [Build Failed]

    - name: Priority

      valueProvider: !SpecifiedValue

        value: [Normal]

    - name: Assignees

      valueProvider: !ScriptingValue

        scriptName: builtin:determine-build-failure-investigator

    - name: Build

      valueProvider: !ScriptingValue

        scriptName: builtin:get-build-number

  retryCondition: never

  maxRetries: 3

  retryDelay: 30

  timeout: 3600
```

--------------------------------

### Upgrade OneDev to use external PostgreSQL database

Source: https://docs.onedev.io/installation-guide/deploy-to-k8s

Upgrades an existing OneDev installation to use an external PostgreSQL database. The database should be empty initially. Replace example host and credentials with your own.

```bash
helm upgrade onedev onedev/onedev -n onedev --set database.external=true --set database.type=postgresql --set database.host=postgresql.example.com --set-string database.port=5432 --set database.name=onedev --set database.user=dbuser --set database.password=dbpassword --reuse-values  
```

--------------------------------

### Add server credentials to settings.xml

Source: https://docs.onedev.io/tutorials/package/working-with-maven

Add this to $HOME/.m2/settings.xml to deploy from the command line. If settings.xml already exists, merge the server entry into its existing <settings> element. The server ID must match the repository ID in pom.xml. Keep credentials out of source control.

```xml
<settings>  

    <servers>  

        <server>  

            <id>onedev</id>  

            <username>onedev_account_name</username>  

            <password>onedev_password_or_access_token</password>  

        </server>  

    </servers>  

</settings>  


```

--------------------------------

### Upgrade OneDev on VM/Bare Metal

Source: https://docs.onedev.io/upgrade-guide/bare-metal

Run the upgrade command from the new OneDev installation directory, passing the current installation path as an argument. This upgrades the existing installation in place.

```bash
/path/to/new-onedev/bin/upgrade.(sh|bat) /opt/onedev  
```

--------------------------------

### Fetch and list tags with git describe

Source: https://docs.onedev.io/tutorials/cicd/pull-tags

Run after the Checkout Code step in an Execute Commands step. Requires Git installed and enough commit history. The server URL must be reachable from the job environment.

```bash
git fetch --tags  

git tag --list  

git describe --tags  

```

--------------------------------

### Install RubyGems package from OneDev

Source: https://docs.onedev.io/tutorials/package/working-with-rubygems

Install a gem from the OneDev source using gem install with --clear-sources and --source. Use an account or token with package read permission.

```bash
gem install <package> --version <version> --clear-sources --source https://onedev.example.com/<project-path>/~rubygems --no-document
```

--------------------------------

### Install required fonts on ArchLinux

Source: https://docs.onedev.io/installation-guide/run-on-bare-metal

Run this command on ArchLinux to install the fonts required by OneDev.

```bash
sudo pacman -S fontconfig ttf-dejavu
```

--------------------------------

### Create custom settings.xml and deploy in CI/CD

Source: https://docs.onedev.io/tutorials/package/working-with-maven

For CI/CD jobs, this command step creates a custom settings.xml using a job token and a job secret, then runs mvn deploy. The job secret 'access-token' should be defined in project build settings as an access token with package write permission.

```bash
cat << EOF > settings.xml  

<settings>  

    <servers>  

        <server>  

            <id>onedev</id>  

            <!-- Use job token as user name so that OneDev can know which build is deploying packages -->  

            <username>@job_token@</username>  

            <!-- Job secret 'access-token' should be defined in project build setting as an access token with package write permission -->  

            <password>@secret:access-token@</password>  

        </server>  

    </servers>  

</settings>  

EOF  

  

mvn --settings settings.xml clean deploy  


```

--------------------------------

### Install latest OneDev release with Helm

Source: https://docs.onedev.io/installation-guide/deploy-to-k8s

Installs the latest OneDev release into the 'onedev' namespace, creating it if needed.

```bash
helm install onedev onedev/onedev -n onedev --create-namespace  
```

--------------------------------

### Create React app and push to OneDev

Source: https://docs.onedev.io/tutorials/code/gitops

Commands to create a React project and push it to a OneDev repository. Requires node.js environment and OneDev admin credentials for authentication.

```bash
$ npx create-react-app gitops-demo $ cd gitops-demo$ git remote add origin http://<OneDev external ip>/gitops-demo$ git push --set-upstream origin master     
```

--------------------------------

### Install specific OneDev version with Helm

Source: https://docs.onedev.io/installation-guide/deploy-to-k8s

Installs a specific OneDev release by specifying its chart version with --version.

```bash
helm install onedev onedev/onedev --version <OneDev version> -n onedev --create-namespace  
```

--------------------------------

### Switch to Production Certificate

Source: https://docs.onedev.io/installation-guide/deploy-to-k8s

Run this Helm upgrade command to switch to a production certificate from Let's Encrypt.

```bash
helm upgrade onedev onedev/onedev -n onedev --set ingress.tls.acme.production=true --reuse-values
```

--------------------------------

### Retry condition example error message with EOF

Source: https://docs.onedev.io/tutorials/cicd/job-retry

Example error message from Kubernetes on Google Kubernetes Engine when a node goes down, containing 'EOF'.

```text
Error from server: Get https://<ip address>:<port>/containerLogs/k8s-test-53/job/main?follow=true&timestamps=true: EOF

  
```

--------------------------------

### Install cert-manager for ACME

Source: https://docs.onedev.io/installation-guide/deploy-to-k8s

Install cert-manager in its own namespace with CRDs enabled and leader election namespace set. This is required for automatic certificate issuance via ACME.

```bash
helm install cert-manager cert-manager --repo https://charts.jetstack.io --namespace cert-manager --create-namespace --set crds.enabled=true --set global.leaderElection.namespace=cert-manager
```

--------------------------------

### Commands to create dist directory

Source: https://docs.onedev.io/tutorials/cicd/build-docker-image

Enter these commands in the Execute Commands step. They create the dist directory and copy index.html into it, then verify the file exists.

```shell
mkdir -p dist  

cp index.html dist/  

test -s dist/index.html  


```

--------------------------------

### Deploy OneDev with Helm

Source: https://docs.onedev.io/tutorials/code/gitops

Install the OneDev Helm chart into your cluster. Requires helm3 to be installed. This command creates the 'onedev' namespace and deploys the chart from the OneDev repository.

```bash
$ helm install onedev onedev --repo https://code.onedev.io/onedev/~helm --namespace onedev --create-namespace  
```

--------------------------------

### Install NPM package from OneDev registry

Source: https://docs.onedev.io/tutorials/package/working-with-npm

Installs a published package from the OneDev registry. Replace <scope>, <package-name>, and <version> with your package details. Requires a token with package read permission.

```bash
npm install @<scope>/<package-name>@<version>
```

--------------------------------

### Add wiki submodule and commit

Source: https://docs.onedev.io/tutorials/wiki/working-with-wiki

Commands to add the wiki repository as a submodule, commit the addition, and push. Replace the example URL with the wiki project's HTTP(S) clone URL.

```bash
git submodule add https://onedev.example.com/team/project-wiki wiki  

git commit -m "Add wiki submodule"  

git push  
```

--------------------------------

### Example .gitmodules entry for SSH submodule

Source: https://docs.onedev.io/tutorials/cicd/clone-submodules

Example .gitmodules entry showing an SSH URL with the same host as OneDev's SSH Root URL, including the correct SSH port.

```git
[submodule "examples"]  

    path = examples  

    url = ssh://git@onedev.example.com:6611/shared/examples.git  

```

--------------------------------

### Get external IP of deployed service in a namespace

Source: https://docs.onedev.io/tutorials/code/gitops

Run this command to get the external IP address of the deployed demo service in a specified namespace. Replace '<namespace>' with the actual namespace name.

```bash
kubectl get service -n <namespace>
```
Tokens:
Raw