Skip to content

Commit

Permalink
Merge pull request #44 from GenomicDataInfrastructure/15-add-reuse-he…
Browse files Browse the repository at this point in the history
…aders

chore: #15 add REUSE headers
  • Loading branch information
brunopacheco1 authored Feb 1, 2024
2 parents 90da4ce + 7255f29 commit 75c9c78
Show file tree
Hide file tree
Showing 31 changed files with 544 additions and 666 deletions.
5 changes: 5 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
# SPDX-FileContributor: PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

# Host Ports
CKAN_PORT_HOST=5500

Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2024 PNED G.I.E.
# SPDX-FileContributor: Stichting Health-RI
#
# SPDX-License-Identifier: AGPL-3.0-only

name: Publish and Deploy main

on:
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2024 PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

name: Publish release

on:
Expand Down
18 changes: 18 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# SPDX-FileCopyrightText: 2024 PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

name: Run Tests

on: push

jobs:
test:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4
- name: REUSE Compliance Check
uses: fsfe/reuse-action@v2
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
# SPDX-FileContributor: PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

# generic
.DS_Store
.vagrant
Expand Down
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2024 PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

[submodule "src/ckanext-gdi-userportal"]
path = src/ckanext-gdi-userportal
url = [email protected]:GenomicDataInfrastructure/ckanext-gdi-userportal.git
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 PNED G.I.E.
SPDX-License-Identifier: CC-BY-4.0
-->

# Changelog

All notable changes to this project will be documented in this file.
Expand Down
6 changes: 6 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 Contributor Covenant
SPDX-FileContributor: PNED G.I.E.
SPDX-License-Identifier: CC-BY-4.0
-->

# Contributor Covenant Code of Conduct

Expand Down
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 PNED G.I.E.
SPDX-License-Identifier: CC-BY-4.0
-->

<!-- omit in toc -->
# Contributing to CKAN Docker GDI User Portal

Expand Down
661 changes: 0 additions & 661 deletions LICENSE

This file was deleted.

235 changes: 235 additions & 0 deletions LICENSES/AGPL-3.0-only.txt

Large diffs are not rendered by default.

156 changes: 156 additions & 0 deletions LICENSES/CC-BY-4.0.txt

Large diffs are not rendered by default.

17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
<!--
SPDX-FileCopyrightText: 2024 PNED G.I.E.
SPDX-License-Identifier: CC-BY-4.0
-->

[![REUSE status](https://api.reuse.software/badge/github.com/GenomicDataInfrastructure/gdi-userportal-ckan-docker)](https://api.reuse.software/info/github.com/GenomicDataInfrastructure/gdi-userportal-ckan-docker)
![example workflow](https://github.com/GenomicDataInfrastructure/gdi-userportal-ckan-docker/actions/workflows/main.yml/badge.svg)
![example workflow](https://github.com/GenomicDataInfrastructure/gdi-userportal-ckan-docker/actions/workflows/release.yml/badge.svg)
![example workflow](https://github.com/GenomicDataInfrastructure/gdi-userportal-ckan-docker/actions/workflows/test.yml/badge.svg)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=GenomicDataInfrastructure_gdi-userportal-ckan-docker&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=GenomicDataInfrastructure_gdi-userportal-ckan-docker)
[![GitHub contributors](https://img.shields.io/github/contributors/GenomicDataInfrastructure/gdi-userportal-ckan-docker)](https://github.com/GenomicDataInfrastructure/gdi-userportal-ckan-docker/graphs/contributors)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
Expand Down Expand Up @@ -68,9 +76,8 @@ more information.
Copying and License
-------------------

This material is copyright (c) 2006-2023 Open Knowledge Foundation and contributors.

It is open and licensed under the GNU Affero General Public License (AGPL) v3.0
whose full text may be found at:
This work is licensed under multiple licences. Here is a brief summary as of January 2024:

http://www.fsf.org/licensing/licenses/agpl-3.0.html
- All original source code is licensed under [AGPL-3.0-only](./LICENSES/AGPL-3.0-only.txt), copyright (c) 2006-2023 Open Knowledge Foundation and contributors.
- All documentation is licensed under [CC-BY-4.0](./LICENSES/CC-BY-4.0.txt).
- For more accurate information, check the individual files.
4 changes: 4 additions & 0 deletions _http/ckan.http
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2024 PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

GET http://localhost:5500/api/action/scheming_package_show?type=dataset&id=5eedc478-87b2-4947-8a9a-c90437440079

###
Expand Down
4 changes: 4 additions & 0 deletions _http/mock_catalogue.http
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# SPDX-FileCopyrightText: 2024 PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

GET http://localhost:8001/catalogue.ttl
5 changes: 5 additions & 0 deletions ckan/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
# SPDX-FileContributor: PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

FROM ckan/ckan-base:2.10.3

# Install any extensions needed by your CKAN instance
Expand Down
5 changes: 5 additions & 0 deletions ckan/Dockerfile.dev
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
# SPDX-FileContributor: PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

FROM ckan/ckan-dev:2.10.3

RUN pip3 install -e git+https://github.com/ckan/[email protected]#egg=ckanext-dcat && \
Expand Down
6 changes: 6 additions & 0 deletions ckan/docker-entrypoint.d/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
SPDX-License-Identifier: AGPL-3.0-only
-->

Use scripts in this folder to run extra initialization steps in your custom CKAN images.
Any file with `.sh` or `.py` extension will be executed just after the main initialization
script (`prerun.py`) is executed and just before the web server and supervisor processes are
Expand Down
4 changes: 4 additions & 0 deletions ckan/docker-entrypoint.d/setup_scheming.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
#!/bin/bash

# SPDX-FileCopyrightText: 2024 PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

# Update the config file with each extension config-options
echo "[ckanext-scheming] Setting up config-options"
ckan config-tool $CKAN_INI -s app:main \
Expand Down
4 changes: 4 additions & 0 deletions ckan/patches/00_test_test.patch
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
#
# SPDX-License-Identifier: AGPL-3.0-only

test
5 changes: 5 additions & 0 deletions ckan/setup/prerun.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
# SPDX-FileContributor: PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

import os
import sys
import subprocess
Expand Down
4 changes: 4 additions & 0 deletions ckan/setup/start_ckan.sh.override
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
#!/bin/sh

# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
#
# SPDX-License-Identifier: AGPL-3.0-only

# Add ckan.datapusher.api_token to the CKAN config file (updated with corrected value later)
ckan config-tool $CKAN_INI ckan.datapusher.api_token=xxx

Expand Down
4 changes: 4 additions & 0 deletions ckan/setup/start_ckan_development.sh.override
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
#!/bin/sh

# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
#
# SPDX-License-Identifier: AGPL-3.0-only

# Install any local extensions in the src_extensions volume
echo "Looking for local extensions to install..."
echo "Extension dir contents:"
Expand Down
5 changes: 5 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
# SPDX-FileContributor: PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

version: "3"

volumes:
Expand Down
4 changes: 4 additions & 0 deletions keycloak/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2024 PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

# First stage: Install curl
FROM registry.access.redhat.com/ubi9 AS ubi-micro-build
RUN mkdir -p /mnt/rootfs
Expand Down
3 changes: 3 additions & 0 deletions keycloak/realms/ckan-realm.json.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2024 PNED G.I.E.

SPDX-License-Identifier: AGPL-3.0-only
4 changes: 4 additions & 0 deletions postgresql/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
#
# SPDX-License-Identifier: AGPL-3.0-only

FROM postgres:12-alpine

# Include extra setup scripts (eg datastore)
Expand Down
4 changes: 4 additions & 0 deletions postgresql/docker-entrypoint-initdb.d/.gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
#
# SPDX-License-Identifier: AGPL-3.0-only

*.sh text eol=lf
6 changes: 6 additions & 0 deletions postgresql/docker-entrypoint-initdb.d/1_create_ckandb.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
#!/bin/bash

# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
# SPDX-FileContributor: PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

set -e

psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL
Expand Down
5 changes: 5 additions & 0 deletions postgresql/docker-entrypoint-initdb.d/2_create_keycloakdb.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
#!/bin/bash

# SPDX-FileCopyrightText: 2024 PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

set -e

echo "Creating $KC_DB_NAME for $KC_DB_USERNAME"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
#!/bin/bash

# SPDX-FileCopyrightText: 2006-2023 Open Knowledge Foundation and contributors
# SPDX-FileContributor: PNED G.I.E.
#
# SPDX-License-Identifier: AGPL-3.0-only

set -e

psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL
Expand Down

0 comments on commit 75c9c78

Please sign in to comment.