Skip to content

Commit

Permalink
Merge branch 'development' into feature/DIMOC-322/update-dev-before-m…
Browse files Browse the repository at this point in the history
…aster
  • Loading branch information
WilcoLouwerse committed Oct 15, 2024
2 parents 1299881 + b0aea90 commit 26f3284
Show file tree
Hide file tree
Showing 17 changed files with 161 additions and 123 deletions.
95 changes: 61 additions & 34 deletions .github/workflows/release-workflows.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,50 @@ on:
push:
branches:
- master
- main
workflow_dispatch:
inputs:
version:
description: 'Version to release (leave empty to use info.xml version)'
required: false
default: ''

jobs:
release-management:
runs-on: ubuntu-latest
steps:

- name: Checkout Code
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Set app env
run: |
# Split and keep last
echo "APP_NAME=${GITHUB_REPOSITORY##*/}" >> $GITHUB_ENV
echo "APP_VERSION=${GITHUB_REF##*/}" >> $GITHUB_ENV
# Step 1: Checkout the code
- name: Checkout Code
uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }} # Checkout the correct branch name
fetch-depth: 0 # Fetch the whole repo history
- name: Get current version and increment
id: increment_version
run: |
current_version=$(grep -oP '(?<=<version>)[^<]+' appinfo/info.xml)
IFS='.' read -ra version_parts <<< "$current_version"
((version_parts[2]++))
new_version="${version_parts[0]}.${version_parts[1]}.${version_parts[2]}"
echo "NEW_VERSION=$new_version" >> $GITHUB_ENV
echo "new_version=$new_version" >> $GITHUB_OUTPUT
- name: Update version in info.xml
run: |
sed -i "s|<version>.*</version>|<version>${{ env.NEW_VERSION }}</version>|" appinfo/info.xml
# Step 2: Prepare the signing certificate and key
- name: Commit version update
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git commit -am "Bump version to ${{ env.NEW_VERSION }}"
git push
# Step 1: Prepare the signing certificate and key
- name: Prepare Signing Certificate and Key
run: |
echo "${{ secrets.NEXTCLOUD_SIGNING_CERT }}" > signing-cert.crt
Expand Down Expand Up @@ -51,10 +75,10 @@ jobs:
# Step 7: Build composer dependencies
- run: composer i --no-dev

# Step 8: Copy the files into the package directory, excluding .git and package itself
# Step 8: Copy the files into the package directory
- name: Copy the package files into the package
run: |
mkdir -p package/opencatalogi
mkdir -p package/${{ github.event.repository.name }}
rsync -av --progress \
--exclude='package' \
--exclude='.git' \
Expand All @@ -63,7 +87,7 @@ jobs:
--exclude='docker' \
--exclude='docs' \
--exclude='node_modules' \
--exclude='src' \
--exclude='/src' \
--exclude='test' \
--exclude='package-lock.json' \
--exclude='composer.lock' \
Expand All @@ -90,17 +114,17 @@ jobs:
--exclude='stylelint.config.js' \
--exclude='.babelrc' \
--exclude='.nvmrc' \
./ package/opencatalogi/
./ package/${{ github.event.repository.name }}/
# Step 9: Create the TAR.GZ archive with code in opencatalogi directory
# Step 9: Create the TAR.GZ archive
- name: Create Tarball
run: |
cd package && tar -czf ../nexcloud-release.tar.gz opencatalogi
cd package && tar -czf ../nextcloud-release.tar.gz ${{ github.event.repository.name }}
# Step 10: Sign the TAR.GZ file with OpenSSL
- name: Sign the TAR.GZ file with OpenSSL
run: |
openssl dgst -sha512 -sign signing-key.key nexcloud-release.tar.gz | openssl base64 -out nexcloud-release.signature
openssl dgst -sha512 -sign signing-key.key nextcloud-release.tar.gz | openssl base64 -out nextcloud-release.signature
# Step 11: Generate Git version information
- name: Git Version
Expand All @@ -118,52 +142,55 @@ jobs:
# Step 13: Run Changelog CI
- name: Run Changelog CI
if: github.ref == 'refs/heads/master'
if: github.ref == 'refs/heads/main'
uses: saadmk11/[email protected]
with:
release_version: ${{ steps.version.outputs.version }}
release_version: ${{ env.NEW_VERSION }}
config_file: changelog-ci-config.json

# Step 14: Output the version
- name: Use the version
run: |
echo ${{ steps.version.outputs.version }}
# Step 15: Copy the files into the package directory, excluding .git and package itself
# Step 15: Copy the package files into the package (this step seems redundant, consider removing)
- name: Copy the package files into the package
run: |
mkdir -p package/opencatalogi
rsync -av --progress --exclude='package' --exclude='.git' ./ package/opencatalogi/
mkdir -p package/${{ github.event.repository.name }}
rsync -av --progress --exclude='package' --exclude='.git' ./ package/${{ github.event.repository.name }}/
# Step 18: Create a new release on GitHub
- name: Upload Release
uses: ncipollo/[email protected]
with:
artifacts: |
LICENSE.md
nexcloud-release.tar.gz
nexcloud-release.signature
opencatalogi-build.zip
opencatalogi-build.tar.gz
token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ steps.version.outputs.version }}
tag: v${{ env.NEW_VERSION }}
name: Release ${{ env.NEW_VERSION }}
draft: false
prerelease: false

- name: Attach tarball to github release
uses: svenstaro/upload-release-action@04733e069f2d7f7f0b4aebc4fbdbce8613b03ccd # v2
id: attach_to_release
with:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: nexcloud-release.tar.gz
asset_name: ${{ env.APP_NAME }}-${{ env.APP_VERSION }}.tar.gz
tag: ${{ github.ref }}
file: nextcloud-release.tar.gz # Corrected spelling
asset_name: ${{ env.APP_NAME }}-${{ env.NEW_VERSION }}.tar.gz
tag: v${{ env.NEW_VERSION }}
overwrite: true

- name: Upload app to Nextcloud appstore
uses: nextcloud-releases/nextcloud-appstore-push-action@a011fe619bcf6e77ddebc96f9908e1af4071b9c1 # v1
with:
app_name: ${{ env.APP_NAME }}
appstore_token: ${{ secrets.NEXTCLOUD_APPSTORE_TOKEN }}
download_url: ${{ steps.attach_to_release.outputs.browser_download_url }}
download_url: https://github.com/${{ github.repository }}/releases/download/v${{ env.NEW_VERSION }}/${{ env.APP_NAME }}-${{ env.NEW_VERSION }}.tar.gz
app_private_key: ${{ secrets.NEXTCLOUD_SIGNING_KEY }}

nightly: false

- name: Verify version and contents
run: |
echo "App version: ${{ env.NEW_VERSION }}"
echo "Tarball contents:"
tar -tvf nextcloud-release.tar.gz
echo "info.xml contents:"
tar -xOf nextcloud-release.tar.gz ${{ env.APP_NAME }}/appinfo/info.xml
2 changes: 1 addition & 1 deletion appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Create a [bug report](https://github.com/OpenCatalogi/.github/issues/new/choose)
Create a [feature request](https://github.com/OpenCatalogi/.github/issues/new/choose)
]]></description>
<version>0.6.6</version>
<version>0.6.18</version>
<licence>agpl</licence>
<author mail="[email protected]" homepage="https://www.conduction.nl/">Conduction</author>
<author mail="[email protected]" homepage="https://acato.nl/">Acato</author>
Expand Down
12 changes: 11 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,21 @@ volumes:
config:

services:
frontend:
portal:
image: acatonl/woo-ui-develop
ports:
- "8081:80"

catalog:
image: ghcr.io/opencatalogi/web-app:dev
ports:
- "8082:8080"

woo:
image: ghcr.io/conductionnl/woo-website:dev
ports:
- "8083:8080"

db:
image: mariadb:10.6
restart: always
Expand Down
Binary file added docs/.gitbook/assets/image (3).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/image (4).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 5 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
***

---
description: >-
Welkom bij de gebruikersdocumentatie voor de OpenCatalogi Nextcloud App. Veel
succes met het gebruik van de app.
----------------------------------
Welkom bij de gebruikersdocumentatie voor de OpenCatalogi Nextcloud App. Veel
succes met het gebruik van de app.
---

# Welkom

Expand All @@ -24,4 +23,4 @@ Deze documentatie is bedoeld voor diverse doelgroepen:

Voor meer informatie over OpenCatalogi en onze gemeenschappelijke inspanningen, bezoek onze [documentatie-pagina](https://documentatie.opencatalogi.nl) of de officiële website op [OpenCatalogi.nl](https://opencatalogi.nl).

Veel succes met het gebruik van de app. Voor vragen of bijdragen, neem gerust contact met ons op via <[email protected]>.
Veel succes met het gebruik van de app. Voor vragen of bijdragen, neem gerust contact met ons op via [[email protected]](mailto:[email protected]).
11 changes: 5 additions & 6 deletions docs/beheerders/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
***

---
description: >-
De rol van een "Beheerder" binnen het platform is gericht op het beheren van
de publicaties, catalogi en metadata, evenals de autorisatie van gebruikers.
De verantwoordelijkheden van de beheerder:
------------------------------------------
De rol van een "Beheerder" binnen het platform is gericht op het beheren van
de publicaties, catalogi en metadata, evenals de autorisatie van gebruikers.
De verantwoordelijkheden van de beheerder:
---

# Beheerders

Expand Down
11 changes: 5 additions & 6 deletions docs/developers/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
***

---
description: >-
De rol van een "Developer" binnen het publicatieplatform is voornamelijk
gericht om bij te dragen aan de ontwikkeling aan de codebase of om
aanpassingen te kunnen testen of demonstreren.
----------------------------------------------
De rol van een "Developer" binnen het publicatieplatform is voornamelijk
gericht om bij te dragen aan de ontwikkeling aan de codebase of om
aanpassingen te kunnen testen of demonstreren.
---

# Developers

Expand Down
26 changes: 15 additions & 11 deletions docs/developers/installatie-van-nextcloud-demo-test-omgeving.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Installatie van Nextcloud Demo/Test-omgeving

> NOTE: De Demo/Testomgeving is aangeraden voor demonstraties of ontwikkeling tegen de OpenCatalogi-app (bijvoorbeeld een User Interface. Indien je aan de OpenCatalogi-app zelf wilt ontwikklen, kijk dan bij de [development-omgeving](installatie-van-nextcloud-development-omgeving.md)


## Wat Je Nodig Hebt

Om alles soepel te laten draaien, heb je het volgende nodig:
Expand All @@ -21,22 +25,22 @@ Volg deze eenvoudige stappen om de applicatie te starten:
* [Download](https://raw.githubusercontent.com/OpenCatalogi/.github/main/docs/assets/Start-docker.bat) het `.bat`-bestand. Dit doe je door de link op te slaan (rechtermuisknop opslaan als, let op dat je het bestand opslaat als `.bat`)
* Plaats het bestand als `.bat` in dezelfde folder als de code.
* Klik met de rechtermuisknop op het bestand en selecteer uitvoeren **(Optie 2, via command line interface)**
* Type het volgende commando in de Command prompt en druk op Enter:
* Type het volgende commando in de Command prompt en druk op Enter:

`cd pad/naar/uitgepakte/map`
* Vervang `pad/naar/uitgepakte/map` door de locatie waar je de bestanden hebt uitgepakt. Bijvoorbeeld:
`cd pad/naar/uitgepakte/map`
* Vervang `pad/naar/uitgepakte/map` door de locatie waar je de bestanden hebt uitgepakt. Bijvoorbeeld:

`cd C:\Users\{{jouwgebruikersnaam}}\Downloads\opencatalogi-main`
* Typ het volgende commando in de command prompt en druk op Enter:
`cd C:\Users\{{jouwgebruikersnaam}}\Downloads\opencatalogi-main`
* Typ het volgende commando in de command prompt en druk op Enter:

`docker compose up`
* Wacht tot de applicatie is opgestart. Je ziet veel tekst voorbij komen, het kan 5-10 minuten duren voordat je deze laatste melding ziet:
`docker compose up`
* Wacht tot de applicatie is opgestart. Je ziet veel tekst voorbij komen, het kan 5-10 minuten duren voordat je deze laatste melding ziet:

`[core:notice] [pid 1] AH00094: Command line: 'apache2 -D FOREGROUND'`
5. **Open de applicatie**: Open je webbrowser en ga naar <http://localhost:8080>
`[core:notice] [pid 1] AH00094: Command line: 'apache2 -D FOREGROUND'`
5. **Open de applicatie**: Open je webbrowser en ga naar [http://localhost:8080](http://localhost:8080)
6. **Login**: Voor de standaardinstallatie werkt dit met admin als log **en** admin wachtwoord

Je hebt nu een werkende Nextcloud-test en demo-omgeving. Om OpenCatalogi te activeren, volg dan [deze stappen](de-opencatalogi-app-toevoegen-aan-nextcloud.md)
De OpenCatalogi-app is te vinden in de Nextcloud-appstore bij de Intergration-categorie.

En dat is het! Volg deze stappen om de OpenCatalogi-app snel en soepel op te zetten.

Expand All @@ -49,7 +53,7 @@ Het kan natuurlijk voorkomen dat je na een succesvolle demonstratie de toepassin
* Vink onder `volumes` alle volumes aan en druk op 'delete'
* Verwijder de folder met bestanden die in stap 3 van het installatieproces heb aangemaakt

![alt text](docker_desktop.png)
![alt text](docker\_desktop.png)

## Bijwerken

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# Installatie van Nextcloud Development-omgeving

Als je aan de slag wilt met het ontwikkelen voor Open Catalogi kan je beter een development-omgeving neerzetten, de instructies daarvoor vind je als [tutorial op nextcloud](https://cloud.nextcloud.com/s/iyNGp8ryWxc7Efa?path=%2F1%20Setting%20up%20a%20development%20environment).
> NOTE: deze route is alleen nodig als je aan de app zelf wilt ontwikkelen. Indien je alleen de app nodig hebt om tegen te ontwikkelen, kijk bij [Demo/Testomgeving](installatie-van-nextcloud-demo-test-omgeving.md)\
> als [tutorial op nextcloud](https://cloud.nextcloud.com/s/iyNGp8ryWxc7Efa?path=%2F1%20Setting%20up%20a%20development%20environment).
## De code voor de OpenCatalogi-app

Het toevoegen van een Nextcloud app is niet moeilijk, maar het helpt wel als je basiskennis hebt van git en hoe applicatiestructuren ingedeeld zijn. Deze handleiding gaat uit van een succesvolle installatie van Nextcloud. Er is [hiervoor](https://cloud.nextcloud.com/s/iyNGp8ryWxc7Efa?path=%2F1%20Setting%20up%20a%20development%20environment) een goede tutorial te vinden van Nextcloud zelf.
Het toevoegen van een Nextcloud app is niet moeilijk, maar het helpt wel als je basiskennis hebt van `git` en hoe applicatiestructuren ingedeeld zijn. Deze handleiding gaat uit van een succesvolle installatie van Nextcloud. Er is [hiervoor](https://cloud.nextcloud.com/s/iyNGp8ryWxc7Efa?path=%2F1%20Setting%20up%20a%20development%20environment) een goede tutorial te vinden van Nextcloud zelf.

De makkelijkste manier is om naar de repository te gaan van de [OpenCatalogi-Nextcloud app](https://github.com/ConductionNL/opencatalogi) en de code te kopieren naar de juiste Nextcloud-directory.

Dat kan op 2 manieren.

1. De `git clone`-manier (verondersteld dat je [git](https://git-scm.com/) geinstalleerd hebt):
1. De `git clone`-manier (verondersteld dat je [git](https://git-scm.com/) geïnstalleerd hebt):

Ga in jouw terminal naar de "apps-extra"-directory. Die is te vinden in `nextcloud-docker-dev/workspace/server/apps-extra/`

Expand All @@ -20,11 +21,12 @@ en daar het volgende commando's uit te voeren.
git clone https://github.com/ConductionNL/opencatalogi.git
cd opencatalogi
npm install
docker compose up nextcloud proxy
npm run dev
docker compose up
```

2. in plaats van de git clone, kan er gekozen worden voor de code te downloaden in een `.ZIP-bestand` en daarna uit te pakken in de `apps-extra`-directory. Dit vervangt het `git clone`-commando. De rest van de stappen zijn hetzelfde.
2. in plaats van de `git clone`, kan er gekozen worden voor de code te downloaden in een `.ZIP-bestand` en daarna uit te pakken in de `apps-extra`-directory. Dit vervangt het `git clone-`commando. De rest van de stappen zijn hetzelfde.

Hou er rekening mee dat er afspraken zijn over het terugleveren van ontwikkelinde code die vind je [hier](aan-de-slag-met-development.md).
Hou er rekening mee dat er afspraken zijn over het terugleveren van ontwikkelde code die vind je [hier](aan-de-slag-met-development.md).

Nadat je de code lokaal hebt gekopieerd moet je de app toevoegen en activeren. Kijk daarvoor onder [app toevoegen](de-opencatalogi-app-toevoegen-aan-nextcloud.md).
11 changes: 5 additions & 6 deletions docs/gebruikers/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
***

---
description: >-
Een "Gebruiker" binnen het Publicatieplatform heeft de primaire taak om
publicaties te creëren en te bewerken. De rol van de gebruiker omvat de
volgende verantwoordelijkheden en mogelijkheden:
------------------------------------------------
Een "Gebruiker" binnen het Publicatieplatform heeft de primaire taak om
publicaties te creëren en te bewerken. De rol van de gebruiker omvat de
volgende verantwoordelijkheden en mogelijkheden:
---

# Gebruikers

Expand Down
11 changes: 5 additions & 6 deletions docs/gebruikers/dashboard.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
***

---
description: >-
Deze handleiding gaat ervan uit dat de gebruiker beschikt tot een werkende
OpenCatalogi-Nextcloud app
--------------------------
Deze handleiding gaat ervan uit dat de gebruiker beschikt tot een werkende
OpenCatalogi-Nextcloud app
---

# Dashboard

Expand All @@ -19,7 +18,7 @@ Op het dashboard van OpenCatalogi vindt u handige informatie die je meteen verde
2. **Metadata** De verdeling over metadata-types van jouw publicaties
3. **Status** De verdeling over statustypes van jouw publicaties

![app menu](../assets/oc_dashboard.png)
![app menu](../assets/oc\_dashboard.png)

### Sidebar

Expand Down
Loading

0 comments on commit 26f3284

Please sign in to comment.