Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
amercader committed Dec 3, 2024
1 parent 298ddfa commit 2ade49e
Showing 1 changed file with 34 additions and 11 deletions.
45 changes: 34 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,38 @@

These scripts are used to build Debian packages (deb files) for CKAN releases.

> [!NOTE] As of July 2024, Docker is used as a building environment to create the deb packages.
> [!WARNING] These scripts are used by CKAN maintainers. If you want to install CKAN, including
> via Debian package, check the [installation documentation](https://docs.ckan.org/en/latest/maintaining/installing/index.html)
> [!NOTE] As of December 2024, Docker is used as a building environment to create the deb packages.
> The previous Ansible / Vagrant setup is no longer used
## Overview

To create Debian packages of CKAN, install Docker and run:
To create Debian packages of CKAN, use the `ckan-package` executable:

```
docker buildx build \
--output type=local,dest=. \
--build-arg CKAN_VERSION=2.11 \
--build-arg CKAN_BRANCH=dev-v2.11 \
--build-arg DATAPUSHER_VERSION=0.0.21 \
--build-arg DISTRIBUTION=noble \
--build-arg UBUNTU_VERSION=24.04 \
.
/ckan-package --help
usage: ckan-package [-h] [-i ITERATION] ref target
Builds CKAN deb packages. This script essentially sets up the necessary vars and calls `docker buildx build`.
positional arguments:
ref The CKAN branch or tag to build (e.g. master, dev-v2.11, ckan-2.10.6...)
target The Ubuntu distribution to target (e.g. focal, jammy, noble...)
optional arguments:
-h, --help show this help message and exit
-i ITERATION, --iteration ITERATION
The iteration number to add to the package name.
```

For instance:

./ckan-package ckan-2.11.1 noble
./ckan-package dev-v2.11 jammy
./ckan-package master noble

The currently supported packages are:

| CKAN version | Ubuntu version |
Expand All @@ -32,6 +46,15 @@ The currently supported packages are:
Any other combination is not officially supported, although you might be able to
build it tweaking the parameters above.

# How it works

Under the hood, the `ckan-package` command just calls `docker buildx build`. You can
call it directly using the appropiate build arguments:

TODO
```
docker buildx build \
--output type=local,dest=. \
--build-arg CKAN_REF=ckan-2.11.0 \
--build-arg UBUNTU_VERSION=24.04 \
.
```

0 comments on commit 2ade49e

Please sign in to comment.