Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drop sddi social #68

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/devel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
paths:
- sddi-base/**
- sddi/**
- sddi-social/**

env:
REGISTRY: ghcr.io
Expand All @@ -17,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
context: ['sddi-base', 'sddi', 'sddi-social']
context: ['sddi-base', 'sddi']
fail-fast: true
max-parallel: 1
permissions:
Expand Down
3 changes: 1 addition & 2 deletions .github/workflows/edge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
paths:
- sddi-base/**
- sddi/**
- sddi-social/**

env:
REGISTRY: ghcr.io
Expand All @@ -17,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
context: ['sddi-base', 'sddi', 'sddi-social']
context: ['sddi-base', 'sddi']
fail-fast: true
max-parallel: 1
permissions:
Expand Down
64 changes: 0 additions & 64 deletions .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ on:
paths:
- sddi-base/**
- sddi/**
- sddi-social/**

env:
REGISTRY: ghcr.io
Expand Down Expand Up @@ -160,66 +159,3 @@ jobs:
run: |
echo "${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev:sddi-pr-${{github.event.number}}-debug"
echo "${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev:sddi-pr-${{github.event.number}}-${{ steps.short-sha.outputs.sha }}-debug"

# SDDI-SOCIAL
-
name: Extract metadata (tags, labels) for docker image
id: meta-sddi-social
uses: docker/metadata-action@v4
with:
images: |
${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev
tags: |
type=ref,event=pr,prefix=sddi-social-pr-
type=ref,event=pr,prefix=sddi-social-pr-,suffix=-{{sha}}
labels: |
maintainer=Chair of Geoinformatics, Technical University of Munich (TUM)
org.opencontainers.image.vendor=Chair of Geoinformatics, Technical University of Munich (TUM)
org.opencontainers.image.title=ckan-sddi-social-docker-dev
-
name: Build and publish ${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev:sddi-social-pr-${{github.event.number}}
uses: docker/build-push-action@v4
with:
push: true
context: sddi-social
tags: ${{ steps.meta-sddi-social.outputs.tags }}
labels: ${{ steps.meta-sddi-social.outputs.labels }}
build-args: |
BASEIMAGE_REPOSITORY=${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev
BASEIMAGE_VERSION=sddi-pr-${{github.event.number}}-${{ steps.short-sha.outputs.sha }}
-
name: Print image names
run: |
echo "${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev:sddi-social-pr-${{github.event.number}}"
echo "${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev:sddi-social-pr-${{github.event.number}}-${{ steps.short-sha.outputs.sha }}"
-
name: Extract metadata (tags, labels) for docker image
id: meta-sddi-social-debug
uses: docker/metadata-action@v4
with:
images: |
${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev
tags: |
type=ref,event=pr,prefix=sddi-social-pr-,suffix=-debug
type=ref,event=pr,prefix=sddi-social-pr-,suffix=-{{sha}}-debug
labels: |
maintainer=Chair of Geoinformatics, Technical University of Munich (TUM)
org.opencontainers.image.vendor=Chair of Geoinformatics, Technical University of Munich (TUM)
org.opencontainers.image.title=ckan-sddi-social-docker-dev-debug
-
name: Build and publish ${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev:sddi-social-pr-${{github.event.number}}-debug
uses: docker/build-push-action@v4
with:
push: true
context: sddi-social
file: sddi-social/Dockerfile.debug
tags: ${{ steps.meta-sddi-social-debug.outputs.tags }}
labels: ${{ steps.meta-sddi-social-debug.outputs.labels }}
build-args: |
BASEIMAGE_REPOSITORY=${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev
BASEIMAGE_VERSION=sddi-pr-${{github.event.number}}-${{ steps.short-sha.outputs.sha }}
-
name: Print image names
run: |
echo "${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev:sddi-social-pr-${{github.event.number}}-debug"
echo "${{ env.REGISTRY }}/tum-gis/ckan-sddi-dev:sddi-social-pr-${{github.event.number}}-${{ steps.short-sha.outputs.sha }}-debug"
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
context: ['sddi-base', 'sddi', 'sddi-social']
context: ['sddi-base', 'sddi']
fail-fast: true
max-parallel: 1
permissions:
Expand Down
45 changes: 27 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,44 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
For releases `< 1.0.0` minor version steps may indicate breaking changes too.

## [Unreleased] - 2024-10-18

### Added

### Changed

### Removed

- `sddi-social` image flavor.

### Fixed

### Security

### Deprecated

### Known issues

## [2.1.2] - 2024-04-17

### Added

- Variable that defines after how many seconds of user inactivity the user is logged out `who.timeout = 1800`

### Fixed
- Various `ckanext-grouphierarchy-sddi` updates and fixing of styling bugs. See [CHANGELOG](https://github.com/tum-gis/ckanext-grouphierarchy-sddi/releases/tag/1.1.4) for changes.

- Various `ckanext-grouphierarchy-sddi` updates and fixing of styling bugs.
See [CHANGELOG](https://github.com/tum-gis/ckanext-grouphierarchy-sddi/releases/tag/1.1.4) for changes.
- Removed "Remember me" button on the login page
- Fixing the missing variables for personalization of the main page
- Repair the view of the dataset added by the organization on the main page
-

## [2.1.1] - 2024-04-17

## [2.1.0] - 2024-04-17

## [2.0.1] - 2023-11-07

### Added

- Expanding the Dataset Spatial Extend preview. tum-gis/ckan-docker#52
Expand Down Expand Up @@ -201,22 +226,6 @@ for production environments.**
- Initial release to initialize Github packages.
- **Images are not functional jet**!

## [Unreleased] - YYYY-MM-DD

### Added

### Changed

### Removed

### Fixed

### Security

### Deprecated

### Known issues

## [template] - YYYY-MM-DD

### Added
Expand Down
67 changes: 28 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ See [packages](https://github.com/orgs/tum-gis/packages?repo_name=ckan-docker) f
- [:inbox\_tray: Image flavor overview](#inbox_tray-image-flavor-overview)
- [`sddi-base`](#sddi-base)
- [`sddi`](#sddi)
- [`sddi-social`](#sddi-social)
- [:1234: Image versioning](#1234-image-versioning)
- [Development image versions](#development-image-versions)
- [CKAN and CKAN extension versions](#ckan-and-ckan-extension-versions)
Expand All @@ -64,15 +63,13 @@ See [packages](https://github.com/orgs/tum-gis/packages?repo_name=ckan-docker) f

## :inbox_tray: Image flavor overview

The CKAN-SDDI Docker images are released in three flavors, that are described below.
For each flavor a one [package](https://github.com/orgs/tum-gis/packages?repo_name=ckan-docker)
exists in this repository, where the image can be pulled.
The CKAN-SDDI Docker images are released in two flavors, that are described below.
For each flavor one [package](https://github.com/orgs/tum-gis/packages?repo_name=ckan-docker)
exists in this repository.

```bash
docker pull ghcr.io/tum-gis/ckan-sddi-base
docker pull ghcr.io/tum-gis/ckan-sddi
docker pull ghcr.io/tum-gis/ckan-sddi-social

```

### `sddi-base`
Expand All @@ -95,32 +92,26 @@ This is the image most people will usually want.
ghcr.io/tum-gis/ckan-sddi
```

### `sddi-social`

`sddi` + optional CKAN extension for social media features, that may require staff
for moderation of social media content.

```text
ghcr.io/tum-gis/ckan-sddi-social
```

## :1234: Image versioning

The images in this repo are versioned and tagged according to the
[releases](https://github.com/tum-gis/ckan-docker/releases) of this repository.
The `latest` tag points to the latest release number. The `edge` version is built from the
The `latest` tag points to the latest release semver. The `edge` version is built from the
latest commit to the `main` branch of this repo.

All available tags are listed in the packages of each image:

- [`sddi-base`](https://github.com/tum-gis/ckan-docker/pkgs/container/ckan-sddi-base)
- [`sddi`](https://github.com/tum-gis/ckan-docker/pkgs/container/ckan-sddi)
- [`sddi-social`](https://github.com/tum-gis/ckan-docker/pkgs/container/ckan-sddi-social)

### Development image versions

For development purposes the `devel` images, which are build from the latest commit to the `devel` branch are published.
The `devel` images are used for testing and may contain errors.

> [!CAUTION]
> The `devel` images are used for testing and development. They may contain errors and security threats.
> Do not use them in a production environment or when handling sensitive data.

The CKAN and CKAN extension versions used for each image are listed in the table below.

For debugging we provide a *debug* version for each image version.
Expand All @@ -130,8 +121,10 @@ Read more on CKAN's debug mode in the
[official docs](https://docs.ckan.org/en/latest/maintaining/configuration.html#debug).
Debug images are available starting from `v0.0.6`.

> **Warning**: The debug image versions should not be used in a production environment!
> [!CAUTION]
> The `-debug` images are used for testing and development. They may contain errors and security threats.
> With debug mode enabled, a visitor to your site could execute malicious commands.
> Do not use them in a production environment or when handling sensitive data.

Furthermore, for each commit to a [Pull request](https://github.com/tum-gis/ckan-docker/pulls) all image flavors are build.
These images are published in the
Expand All @@ -153,10 +146,6 @@ For instance, for commit 19a2e64 to PR tum-gis/ckan-docker#26 following images a
- `ghcr.io/tum-gis/ckan-sddi-dev:sddi-pr-26-debug`
- `ghcr.io/tum-gis/ckan-sddi-dev:sddi-pr-26-19a2e64`
- `ghcr.io/tum-gis/ckan-sddi-dev:sddi-pr-26-19a2e64-debug`
- `ghcr.io/tum-gis/ckan-sddi-dev:sddi-social-pr-26`
- `ghcr.io/tum-gis/ckan-sddi-dev:sddi-social-pr-26-debug`
- `ghcr.io/tum-gis/ckan-sddi-dev:sddi-social-pr-26-19a2e64`
- `ghcr.io/tum-gis/ckan-sddi-dev:sddi-social-pr-26-19a2e64-debug`

This registry will be cleared periodically.

Expand All @@ -177,21 +166,21 @@ are alway pinned to a stable release number or commit hash.
> **Note:** Version pinning is only applied for release versions. The `edge`
> image may depend on upstream branches instead.

| Extension | Version | `sddi-base` | `sddi` | `sddi-social` | Description |
|---|---|:---:|:---:|:---:|---|
| [`scheming`](https://github.com/MarijaKnezevic/ckanext-scheming) | `f98daec` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Configure and share CKAN dataset metadata forms. |
| [`hierarchy`](https://github.com/ckan/ckanext-hierarchy) | `v1.2.0` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Allows to organize organizations and groups in a hierarchy tree (nested groups/orgs). |
| [`grouphierarchysddi`](https://github.com/tum-gis/ckanext-grouphierarchy-sddi) | `1.1.4` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Extends `hierarchy` with pre-defined groups and topics of the SDDI concept. |
| [`relation`](https://github.com/tum-gis/ckanext-relation-sddi) | `1.0.3` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Enables to create and visualize different types of relations (*realated_to*, *depends_on*, *part_of*) between catalog entries. |
| [`spatial`](https://github.com/MarijaKnezevic/ckanext-spatial) | `c2118b9` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Provides the ability to search for datasets according to a given spatial extent. |
| [`datesearch`](https://github.com/MarijaKnezevic/ckanext-datesearch) | `1.0.2` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Provides the ability to search for datasets according to a given time frame. The search includes all datasets, in which the time of validity overlaps in at least one second with the search time frame. |
| [`repeating`](https://github.com/MarijaKnezevic/ckanext-repeating) | `1.0.0` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | This extension provides a way to store repeating fields in CKAN datasets, resources, organizations and groups. |
| [`composite`](https://github.com/EnviDat/ckanext-composite) | `1e6d7bb` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | The extension allows to store structured dataset metadata, single or multiple fields. Only one level of subfields is possible. The subfields can be basic text, date type or dropboxes. |
| [`restricted`](https://github.com/MarijaKnezevic/ckanext-restricted) | `1.0.0` | | :heavy_check_mark: | :heavy_check_mark: | CKAN extension to restrict the accessibility to the resources of a dataset. This way the package metadata is accesible but not the data itself (resource). The resource access restriction level can be individualy defined for every package. |
| [`dcat`](https://github.com/ckan/ckanext-dcat) | `v1.4.0` | | :heavy_check_mark: | :heavy_check_mark: | Allow CKAN to expose and consume metadata from other catalogs using RDF documents serialized using DCAT. |
| [`geoview`](https://github.com/ckan/ckanext-geoview) | `v0.0.20` | | :heavy_check_mark: | :heavy_check_mark: | This extension contains view plugins to display geospatial files and services in CKAN. |
| [`disqus`](https://github.com/ckan/ckanext-disqus) | | | | :heavy_check_mark: | The Disqus extension allows site visitors to comment on individual packages using an AJAX-based commenting system. The downsides of this plugin are that comments are not stored locally and user information is not shared between CKAN and the commenting system. |
| [`password_policy`](https://github.com/keitaroinc/ckanext-password-policy) | `5618dc9`|:heavy_check_mark: |:heavy_check_mark:| :heavy_check_mark: | CKAN extension that adds password policy for all the users. |
| Extension | Version | `sddi-base` | `sddi` | Description |
|---|---|:---:|:---:|---|
| [`scheming`](https://github.com/MarijaKnezevic/ckanext-scheming) | `f98daec` | :heavy_check_mark: | :heavy_check_mark: | Configure and share CKAN dataset metadata forms. |
| [`hierarchy`](https://github.com/ckan/ckanext-hierarchy) | `v1.2.0` | :heavy_check_mark: | :heavy_check_mark: | Allows to organize organizations and groups in a hierarchy tree (nested groups/orgs). |
| [`grouphierarchysddi`](https://github.com/tum-gis/ckanext-grouphierarchy-sddi) | `1.1.4` | :heavy_check_mark: | :heavy_check_mark: | Extends `hierarchy` with pre-defined groups and topics of the SDDI concept. |
| [`relation`](https://github.com/tum-gis/ckanext-relation-sddi) | `1.0.3` | :heavy_check_mark: | :heavy_check_mark: | Enables to create and visualize different types of relations (*realated_to*, *depends_on*, *part_of*) between catalog entries. |
| [`spatial`](https://github.com/MarijaKnezevic/ckanext-spatial) | `c2118b9` | :heavy_check_mark: | :heavy_check_mark: | Provides the ability to search for datasets according to a given spatial extent. |
| [`datesearch`](https://github.com/MarijaKnezevic/ckanext-datesearch) | `1.0.2` | :heavy_check_mark: | :heavy_check_mark: | Provides the ability to search for datasets according to a given time frame. The search includes all datasets, in which the time of validity overlaps in at least one second with the search time frame. |
| [`repeating`](https://github.com/MarijaKnezevic/ckanext-repeating) | `1.0.0` | :heavy_check_mark: | :heavy_check_mark: | This extension provides a way to store repeating fields in CKAN datasets, resources, organizations and groups. |
| [`composite`](https://github.com/EnviDat/ckanext-composite) | `1e6d7bb` | :heavy_check_mark: | :heavy_check_mark: | The extension allows to store structured dataset metadata, single or multiple fields. Only one level of subfields is possible. The subfields can be basic text, date type or dropboxes. |
| [`restricted`](https://github.com/MarijaKnezevic/ckanext-restricted) | `1.0.0` | | :heavy_check_mark: | CKAN extension to restrict the accessibility to the resources of a dataset. This way the package metadata is accesible but not the data itself (resource). The resource access restriction level can be individualy defined for every package. |
| [`dcat`](https://github.com/ckan/ckanext-dcat) | `v1.4.0` | | :heavy_check_mark: | Allow CKAN to expose and consume metadata from other catalogs using RDF documents serialized using DCAT. |
| [`geoview`](https://github.com/ckan/ckanext-geoview) | `v0.0.20` | | :heavy_check_mark: | This extension contains view plugins to display geospatial files and services in CKAN. |
| [`disqus`](https://github.com/ckan/ckanext-disqus) | | | | The Disqus extension allows site visitors to comment on individual packages using an AJAX-based commenting system. The downsides of this plugin are that comments are not stored locally and user information is not shared between CKAN and the commenting system. |
| [`password_policy`](https://github.com/keitaroinc/ckanext-password-policy) | `5618dc9`|:heavy_check_mark: |:heavy_check_mark:| CKAN extension that adds password policy for all the users. |

## :rocket: Usage

Expand Down Expand Up @@ -351,4 +340,4 @@ to the SDDI concepts, tools, documentations, education, and funding:

## :memo: License

This Helm chart is distributed under the Apache License 2.0. See [LICENSE](LICENSE) for more information.
The content of this repository is distributed under the Apache License 2.0. See [LICENSE](LICENSE) for more information.
19 changes: 0 additions & 19 deletions build-noCache.sh
Original file line number Diff line number Diff line change
Expand Up @@ -39,24 +39,5 @@ docker build . \
--build-arg BASEIMAGE_VERSION=${IMAGE_TAG}-debug \
-t "$IMAGE_REPOSITORY/ckan-sddi:${IMAGE_TAG}-debug"

printf "\n\n"

# sddi-social #################################################################
cd ../sddi-social

# sddi-social:TAG
docker build . \
--no-cache \
--build-arg "BASEIMAGE_REPOSITORY=$IMAGE_REPOSITORY/ckan-sddi" \
--build-arg BASEIMAGE_VERSION=${IMAGE_TAG} \
-t "$IMAGE_REPOSITORY/ckan-sddi-social:${IMAGE_TAG}"

# sddi-social:TAG-debug
docker build . \
--no-cache \
--build-arg "BASEIMAGE_REPOSITORY=$IMAGE_REPOSITORY/ckan-sddi" \
--build-arg BASEIMAGE_VERSION=${IMAGE_TAG}-debug \
-t "$IMAGE_REPOSITORY/ckan-sddi-social:${IMAGE_TAG}-debug"

cd ..
printf "\n\n"
24 changes: 1 addition & 23 deletions build-push-noCache.sh
Original file line number Diff line number Diff line change
Expand Up @@ -45,28 +45,6 @@ docker build . \
-t "$IMAGE_REPOSITORY/ckan-sddi:${IMAGE_TAG}-debug"

docker push "$IMAGE_REPOSITORY/ckan-sddi:${IMAGE_TAG}-debug"
printf "\n\n"

# sddi-social #################################################################
cd ../sddi-social

# sddi-social:TAG
docker build . \
--no-cache \
--build-arg "BASEIMAGE_REPOSITORY=$IMAGE_REPOSITORY/ckan-sddi" \
--build-arg BASEIMAGE_VERSION=${IMAGE_TAG} \
-t "$IMAGE_REPOSITORY/ckan-sddi-social:${IMAGE_TAG}"

docker push "$IMAGE_REPOSITORY/ckan-sddi-social:${IMAGE_TAG}"

# sddi-social:TAG-debug
docker build . \
--no-cache \
--build-arg "BASEIMAGE_REPOSITORY=$IMAGE_REPOSITORY/ckan-sddi" \
--build-arg BASEIMAGE_VERSION=${IMAGE_TAG}-debug \
-t "$IMAGE_REPOSITORY/ckan-sddi-social:${IMAGE_TAG}-debug"

docker push "$IMAGE_REPOSITORY/ckan-sddi-social:${IMAGE_TAG}-debug"

cd ..
cd ..cd ..
printf "\n\n"
Loading