Forgejo

https://forgejo.org/docs/
Admin
Forgejo is a free, open-source, self-hostable Git service. It provides a collaborative platform for...
Tokens:300,764
Snippets:2,203
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install a Pub package with examples for latest and specific versions

Source: https://forgejo.org/docs/latest/user/packages/pub

Example commands for installing a package with the latest version or a specific version using the hosted URL.

```bash
# use latest version
dart pub add mypackage --hosted-url=https://forgejo.example.com/api/packages/testuser/pub/
# specify version
dart pub add mypackage:1.0.8 --hosted-url=https://forgejo.example.com/api/packages/testuser/pub/
```

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

### Install example package

Source: https://forgejo.org/docs/latest/user/packages/cran

Example command to install a package named 'testpackage' from the Forgejo CRAN registry.

```r
install.packages("testpackage")
```

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

### Example Conan package install

Source: https://forgejo.org/docs/latest/user/packages/conan

Example install command using the remote 'forgejo' and recipe 'ConanPackage/1.2@forgejo/final'.

```bash
conan install --remote=forgejo ConanPackage/1.2@forgejo/final
```

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

### Example pip install command

Source: https://forgejo.org/docs/latest/user/packages/pypi

Example of installing a package named test_package for user testuser with password password123. This is a concrete example of the install command.

```bash
pip install --index-url https://testuser:password123@forgejo.example.com/api/packages/testuser/pypi/simple --no-deps test_package
```

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

### Example: Install test_package version 1.0.0

Source: https://forgejo.org/docs/latest/user/packages/nuget

Example command that adds the package 'test_package' version 1.0.0 from the 'forgejo' source.

```bash
dotnet add package --source forgejo --version 1.0.0 test_package
```

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

### Example setup with multiple issue templates and pull request template

Source: https://forgejo.org/docs/latest/user/issue-pull-request-templates

Example directory layout with multiple issue template files and a single pull request template file. The issue templates are placed in the issue_template subdirectory, and the pull request template is placed directly in the .forgejo directory.

```text
.forgejo/
  issue_template/
    bug.yaml
    config.yml
    feature.yaml
  pull_request_template.md
```

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

### Install npm package

Source: https://forgejo.org/docs/latest/user/packages/npm

Install a package from the registry. Replace {package_name} with the package name, for example @test/test_package.

```bash
npm install @test/test_package
```

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

### Example setup with single issue template and pull request template

Source: https://forgejo.org/docs/latest/user/issue-pull-request-templates

Example directory layout for a single issue template file and a single pull request template file. The issue template is placed in the ISSUE_TEMPLATE subdirectory, and the pull request template is placed directly in the .forgejo directory.

```text
.forgejo/
  ISSUE_TEMPLATE/
    issue_template.yaml
  pull_request_template.yml
```

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

### Install a RubyGems package with gem install

Source: https://forgejo.org/docs/latest/user/packages/rubygems

Install a package directly with the gem command. The first block is the template; the second is a concrete example.

```bash
gem install --host https://forgejo.example.com/api/packages/{owner}/rubygems {package_name}

```

```bash
gem install --host https://forgejo.example.com/api/packages/testuser/rubygems test_package

```

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

### Example: Publish test_package.1.0.0.nupkg

Source: https://forgejo.org/docs/latest/user/packages/nuget

Example command that pushes the package file to the 'forgejo' source.

```bash
dotnet nuget push --source forgejo test_package.1.0.0.nupkg
```

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

### Service entrypoint example

Source: https://forgejo.org/docs/latest/user/actions

Example of a custom entrypoint for a service container in a job. The entrypoint overrides the default and runs a shell command to start PostgreSQL with a password.

```yaml
on:
  push:
jobs:
  test:
    runs-on: debian-latest
    services:
      custom-entrypoint:
        image: data.forgejo.org/oci/postgres:18
        entrypoint: ['/bin/sh', '-c', 'POSTGRES_PASSWORD=mysecretpassword docker-entrypoint.sh postgres']
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 20
    steps:
      - run: |
          echo "mysecretpassword" | psql --user postgres --host custom-entrypoint -c "SELECT 1"

```

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

### Start Forgejo Runner daemon

Source: https://forgejo.org/docs/latest/admin/actions/installation/binary

After registration, start the runner daemon from the home directory. The example shows the expected output when starting successfully.

```bash
$ whoami
runner
$ pwd
/home/runner
$ forgejo-runner daemon -c runner-config.yml
INFO[2024-09-14T19:19:14+02:00] Starting runner daemon
```

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

### Install a Chef package

Source: https://forgejo.org/docs/latest/user/packages/chef

Install a package from the registry. The first command installs the latest version; the second installs a specific version. Replace {package_name} and optionally {package_version}.

```bash
knife supermarket install {package_name}
```

```bash
knife supermarket install {package_name} {package_version}
```

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

### Install Helm Chart from Registry

Source: https://forgejo.org/docs/latest/user/packages/helm

Installs a Helm chart from the Forgejo registry. Adds the repository, updates it, and installs the chart.

```bash
helm repo add  --username {username} --password {password} {repo} https://forgejo.example.com/api/packages/{owner}/helm
helm repo update
helm install {name} {repo}/{chart}
```

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

### Service usage example

Source: https://forgejo.org/docs/latest/user/actions

Example of defining a service (PostgreSQL) and using it in a job step. The service is accessed by its key name 'pgsql' as the host.

```yaml
services:
  pgsql:
    image: postgres:15
    env:
      POSTGRES_DB: test
      POSTGRES_PASSWORD: postgres
steps:
  - run: PGPASSWORD=postgres psql -h pgsql -U postgres -c '\dt' test

```

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

### vars context example

Source: https://forgejo.org/docs/latest/user/actions

Example of accessing a repository variable using the vars context.

```text
${{ vars.MYVARIABLE }}
```

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

### jobs.<job_id>.steps[*].shell example

Source: https://forgejo.org/docs/latest/user/actions

Sets a custom shell for a step. The example uses dash with the -e flag and a placeholder for the script file.

```yaml
jobs:
  test:
    runs-on: docker
    container:
      image: debian:bookworm
    steps:
      - shell: dash -e {0}
        run: echo using dash here

```

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

### secrets context example

Source: https://forgejo.org/docs/latest/user/actions

Example of accessing a repository secret using the secrets context.

```text
${{ secrets.MYSECRETS }}
```

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

### jobs.<job_id>.steps[*].run example

Source: https://forgejo.org/docs/latest/user/actions

Runs a shell script in the job's environment. The example runs a multi-line script that greps /etc/os-release and echoes SUCCESS.

```yaml
jobs:
  test:
    runs-on: docker
    container:
      image: alpine:latest
    steps:
      - run: |
          grep Alpine /etc/os-release
          echo SUCCESS

```

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

### Container credentials example

Source: https://forgejo.org/docs/latest/user/actions

Example of setting container credentials for a job using the 'docker' runner. The username and password are used to authenticate with the container registry.

```yaml
runs-on: docker
container:
  image: alpine:3.20
  credentials:
    username: 'root'
    password: 'admin1234'

```

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

### workflow_call outputs example with job outputs

Source: https://forgejo.org/docs/latest/user/actions

Concrete example of declaring outputs for a workflow_call, including a callee job that sets a job output accessible via the steps context. The output value is set using the FORGEJO_OUTPUT environment variable.

```YAML
on:
  workflow_call:
    outputs:
      output1:
        value: ${{ jobs.callee.outputs.job-output }}

jobs:
  callee:
    runs-on: docker
    outputs:
      job-output: ${{ steps.stepwithoutput.outputs.myvalue }}
    steps:
      - id: stepwithoutput
        run: |
          echo "myvalue=outputvalue1" >> $FORGEJO_OUTPUT
```

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

### Matrix strategy example

Source: https://forgejo.org/docs/latest/user/actions

Defines a matrix strategy with a single entry for the `info` dimension, setting `version` and `branch` variables. Access values using `${{ matrix.info.version }}`.

```yaml
jobs:
  actions:
    runs-on: self-hosted
    strategy:
      matrix:
        info:
          - version: v1.22
            branch: next
```

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

### Static matrix example for jobs.<job_id>.strategy.matrix

Source: https://forgejo.org/docs/latest/user/actions

Defines a job matrix with variants and node versions, creating four jobs. Uses the `matrix` context to access values, e.g., `${{ matrix.node }}`.

```yaml
jobs:
  test:
    runs-on: self-hosted
    strategy:
      matrix:
        variant: ['bookworm', 'bullseye']
        node: ['18', '20']
    steps:
      - uses: https://code.forgejo.org/actions/setup-node@v4
        with:
          node-version: '${{ matrix.node }}'

```

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

### Use workflow_dispatch inputs with inputs context

Source: https://forgejo.org/docs/latest/user/actions

Shows how to use the inputs context to access workflow_dispatch inputs in a job. In this example, the logLevel input is echoed.

```YAML
jobs:
  test:
    runs-on: docker
    steps:
      - run: echo ${{ inputs.logLevel }}
```

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

### Use workflow_call inputs with inputs context

Source: https://forgejo.org/docs/latest/user/actions

Shows how to use the inputs context inside a job to reference workflow_call inputs. In this example, the number input is echoed.

```YAML
jobs:
  test:
    runs-on: docker
    steps:
      - run: echo ${{ inputs.number }}
```

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

### jobs.<job_id>.steps.if expression example

Source: https://forgejo.org/docs/latest/user/actions

Shows how to use the if expression to conditionally run steps based on the Forgejo event name and action. The example runs one step when a pull request is opened and another when it is closed.

```yaml
jobs:
  my-job:
    steps:
      - name: some-step
        # This step runs when the event that triggerend the workflow was the opening of a pull request
        if: ${{ forgejo.event_name == 'pull_request' && forgejo.event.action == 'opened' }}
      - name: another-step
        # This step runs when the event that triggered the workflow was the closing of a pull request
        if: ${{ forgejo.event_name == 'pull_request' && forgejo.event.action == 'closed' }}

```

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

### Custom container image with container.image

Source: https://forgejo.org/docs/latest/user/actions

Specifies an alternate container image for a job. The example uses Alpine 3.20. Note that images are never updated once downloaded.

```yaml
runs-on: docker
container:
  image: alpine:3.20

```

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

### Define job outputs with jobs.<job_id>.outputs

Source: https://forgejo.org/docs/latest/user/actions

Declares a job's output map, populated by writing to $FORGEJO_OUTPUT. The example sets the output 'job1output' from step1's output value.

```yaml
on: [push]
jobs:
  job1:
    runs-on: docker
    outputs:
      job1output: ${{ steps.step1.outputs.value }}
    steps:
      - id: step1
        run: |
          set -x
          echo "value=value1" >> $FORGEJO_OUTPUT

```

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

### on.workflow_call reusable workflow definition

Source: https://forgejo.org/docs/latest/user/actions

Define a reusable workflow that can be called from another workflow. This example is found in .forgejo/workflows/reusable.yml.

```yaml
on:
  workflow_call:

jobs:
  callee:
    runs-on: docker
    steps:
      - run: echo OK

```

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

### Consume job outputs with jobs.<job_id>.needs

Source: https://forgejo.org/docs/latest/user/actions

Shows how a downstream job uses the output of a previous job via the needs context. The example verifies that the output equals 'value1'.

```yaml
job2:
  needs: [job1]
  runs-on: docker
  steps:
    - run: |
        set -x
        test "${{ needs.job1.outputs.job1output }}" = "value1"

```

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

### on.workflow_call caller workflow

Source: https://forgejo.org/docs/latest/user/actions

Call a reusable workflow from another workflow using the uses keyword. This example calls ./.forgejo/workflows/reusable.yml.

```yaml
on:
  push:

jobs:
  caller:
    uses: ./.forgejo/workflows/reusable.yml

```

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

### Customize markup sanitizer for KaTeX output

Source: https://forgejo.org/docs/latest/admin/config-cheat-sheet

Customizes the sanitization policy for rendered HTML when `RENDER_CONTENT_MODE` is `sanitized`. This example allows KaTeX output from pandoc by permitting `span` elements with the `class` attribute matching the regex. `ALLOW_DATA_URI_IMAGES` is set to true to allow data URI images.

```ini
[markup.sanitizer.TeX]
; Pandoc renders TeX segments as <span>s with the "math" class, optionally
; with "inline" or "display" classes depending on context.
ELEMENT = span
ALLOW_ATTR = class
REGEXP = ^\s*((math(\s+|$)|inline(\s+|$)|display(\s+|$)))+
ALLOW_DATA_URI_IMAGES = true
```

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

### Set job timeout with jobs.<job_id>.timeout-minutes

Source: https://forgejo.org/docs/latest/user/actions

Defines the maximum number of minutes a job can run before it is canceled. In the example, the job is canceled after 1 minute, so the sleep 2m step is interrupted and the echo step never runs.

```yaml
jobs:
  test:
    runs-on: docker
    timeout-minutes: 1
    steps:
      - run: sleep 2m
      - run: echo will never run

```
Tokens:
Raw