Merge pull request #154 from ConductionNL/development

development

.env

@@ -1,176 +1,119 @@
 ##################################################
-#
-# General settings for your component
-#
+# Application settings
 ##################################################
+# This section contains generic settings for your application
 
-##################################################
-# Enviroment settings
-##################################################
+# The shortcode for this component, should be a small set of letters reprecentint the application (use only letters, capitals and spaces)
+APP_NAME=proto-component-commonground
+
+APP_NAME_TECHNICAL=proto-component-commonground
+
+# The description for this api
+APP_DESCRIPTION=Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.
 
-# The shortcode for this component, should be a small set of letters reprecentint the application
-APP_NAME=pc
-# The Full title of the application
-APP_TITLE=Proto component commonground
 # The current version of the application
 APP_VERSION=V1.0
 APP_MAJOR_VERSION=v1
-# Do you want to display the symfony debug toolbar?
-APP_DEBUG=1
-# What is the enviroment type you want to use for local production? (choose between dec,stag,prod, acce or test)
-APP_ENV=dev
-# We use a build to tag images, this is swithced to the version on master and to env on other branches
-APP_BUILD=prod
-# Do wou want to use cashing? true/false
-APP_CACHE=false
-# The description for this api
-APP_DESCRIPTION='Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.'
-# The id for this application in the  WRC
-APP_ID=
 
-# The type of component, can either be application or component
+# The type either application or component
 APP_TYPE=component
 
-APP_LOGO=pc.zaakonline.nl
-APP_HOME=pc.zaakonline.nl
-
-# The urls on wich this api is available
+##################################################
+# Security
+##################################################
+# The urls/ip's and hosts on wich this api is available
 TRUSTED_PROXIES=10.0.0.0/8,172.16.0.0/12,192.168.0.0/16
 TRUSTED_HOSTS=^.+$
-
-# Wheter or not to include ALL datafixtures in a build (used for testing purposes in ci/cd)
-APP_BUILD_ALL_FIXTURES=true
-# Whether or not the component is to be exposed publicly
-APP_WEB=false
-# Whether or not to default cluster internal calls on kubernetes
-APP_INTERNAL=false
-
-# Default authentication key's CHANGE OR DROP on production
-
-# Key that other applications can use to connect to this application
+# Key that other applications can use to connect to this application (hier mag wel iets meer toelichtende tekst bij)
 APP_APPLICATION_KEY=45c1a4b6-59d3-4a6e-86bf-88a872f35845
-# Keys that kan be used to login users to this application
-APP_USER_KEY=79d5b14c-70ab-41fb-ac02-917e3288870b
 
 ##################################################
-# ONLX / Commonground details
+# Licensing / Copyright
 ##################################################
+# The owner (copyright holder) of the code base
+OWNER_NAME=Conduction
+OWNER_URL=https://www.conduction.nl
 
-# Key thats this applicaiton uses to connect to other appliactions
-APP_COMMONGROUND_KEY=45c1a4b6-59d3-4a6e-86bf-88a872f35845
-
-# Key thats this applicaiton uses to connect to other appliactions
-APP_COMMONGROUND_ID=9329d8d0-1d5e-433c-bb47-6991053c7fcb
+# The licence type (the licence file should always be located in the root of the code base as LICENCE.md)
+LICENCE_NAME=EUPL
 
 ##################################################
-# Orgization details
+# Helm / Artifacthub settings
 ##################################################
 
-# The following details describe your organisations and are used for both certificate creation, nlx (if active) and common-ground.dev
-
-ORGANIZATION_NAME=Conduction
-ORGANIZATION_EMAIL_ADDRESS=[email protected]
-ORGANIZATION_COUNTRY_NAME=Netherlands
-ORGANIZATION_STATE=Noord-Holland
-ORGANIZATION_LOCALITY=Amsterdam
-ORGANIZATION_UNIT_NAME=Common-Ground
-
+# The logo for this application (used on the api doc page, in helm files and on Artifacthub)
+APP_LOGO=https://conductionnl.github.io/images/conduction_avatar_blue_on_transparant.svg
+# The addres where more information about this application can be found (used on the api doc page, in helm files and on Artifacthub)
+APP_HOME=https://www.conduction.nl
+# The id of this application on https://artifacthub.io/ (use false if you do not want to  use artifacthub)
+ARTIFACTHUB_ID=
+# name of the organization leave blank to not sure organization
+ARTIFACTHUB_USER=
 ##################################################
-# Documentation settings
+# Routing and domain settings
 ##################################################
 
 # The domain for this component (do not include a subdomain, this will hamper certification generation)
 APP_DOMAIN=conduction.nl
 
 # The subdomain for this component (should be false if you want to use www)
 APP_URL=http://localhost
-APP_SUBDOMAIN=pc
-APP_SUBPATH=pc
+APP_SUBDOMAIN=proto-component-commonground
+APP_SUBPATH=proto-component-commonground
 APP_SUBPATH_ROUTING=true
 
-# The demo enviroment for this component @depracticed
 APP_DEMO=pc.zaakonline.nl
 
-# The Repository for this component
-APP_REPRO=https://github.com/ConductionNL/Proto-component-commonground
-
-# The Helm Charts for this components
-APP_HELM=https://github.com/ConductionNL/Proto-component-commonground/helm
-
-# The repository for the primary (php) container of this project
-APP_CONTAINER=https://hub.docker.com/repository/docker/conduction/pc-php
+# Whether or not the component is to be exposed publicly
+APP_WEB=false
+# Whether or not to default cluster internal calls on kubernetes
+APP_INTERNAL=false
 
 ##################################################
-# Docker settings
+# Github settings
 ##################################################
-
-CONTAINER_REGISTRY_BASE=docker.io/conduction
-CONTAINER_PROJECT_NAME=pc
-# The repository for the primary (php) container of this project
-CONTAINER_REPRO=https://hub.docker.com/repository/docker/conduction/pc-php
+# organization/repo-name
+APP_CHART=ConductionNL/Proto-component-commonground
+# The GIT Repository for this component (The place where the sourcecode is stored)
+APP_REPRO=https://github.com/ConductionNL/Proto-component-commonground
 
 ##################################################
-# ZGW settings
+# Docker settings
 ##################################################
-APP_COMMONGROUND_ZRC_LOCATION=https://openzaak.dev.zuid-drecht.nl/zaken/api/v1
-APP_COMMONGROUND_ZTC_LOCATION=https://openzaak.dev.zuid-drecht.nl/catalogi/api/v1
-APP_COMMONGROUND_DRC_LOCATION=https://openzaak.dev.zuid-drecht.nl/documenten/api/v1
-APP_COMMONGROUND_BRC_LOCATION=https://openzaak.dev.zuid-drecht.nl/besluiten/api/v1
-APP_COMMONGROUND_NRC_LOCATION=https://opennotificaties.dev.zuid-drecht.nl/api/v1
 
-APP_COMMONGROUND_SECRET=!changeMe!
+CONTAINER_REGISTRY_BASE=docker.io/conduction
+HELM_REPOSITORY=https://raw.githubusercontent.com/ConductionNL/Proto-component-commonground/master/api/helm/
+CONTAINER_PROJECT_NAME=proto-component-commonground
 
 ##################################################
 # Notifcation settings
 ##################################################
 
 NOTIFICATION_ENABLED=falsedxfd
-NOTIFICATION_PROVIDER=sasdasdasd
-NOTIFICATION_ENABLED_AUTHORIZATION=sasd
 
 ##################################################
 # Authorization settings
 ##################################################
 
 AUTH_ENABLED=false
-AUTH_PROVIDER_USER=https://uc.zuid-drecht.nl
-AUTH_PROVIDER_APPLICATION=https://openzaak.dev.zuid-drecht.nl/authorizaties/api/v1
-AUTH_AUTHORIZATION=sasd
 
 ##################################################
-# Auditrail settings
+# Development Settings
 ##################################################
+# This sections contains options for configuring your local development environment
 
+APP_ID=
+# Do you want to display the symfony debug toolbar?
+APP_DEBUG=1
+# What is the enviroment type you want to use for local production? (choose between dev, stag, prod, acce or test)
+APP_ENV=dev
+# We use a build to tag images, this is swithced to the version on master and to env on other branches
+APP_BUILD=prod
+# Do you want to use caching? true/false
+APP_CACHE=false
+# Whether or not to include ALL datafixtures in a build (used for testing purposes in ci/cd)
+APP_BUILD_ALL_FIXTURES=true
+# Whether to enable or disable audit trials
 AUDITTRAIL_ENABLED=false
-
-##################################################
-# Healthcheck settings
-##################################################
-
-HEALTH_ENABLED=false
-
-##################################################
-# Archive settings
-##################################################
-
-ARCHIVE_ENABLED=false
-
-##################################################
-# NLX Setup, read more at https://docs.nlx.io/get-started/#
-##################################################
-
-# Do you want to provide an nlx outway? (option for your component to reach nlx services)
-NLX_OUTWAY=true
-
-# Do you want to provice an nlx inway (option for nlx services to reach your api)
-NLX_INWAY=false
-
-# NLX Certification Details
-NLX_COUNTRY_NAME=Netherlands
-NLX_STATE=Noord-Holland
-NLX_LOCALITY=Amsterdam
-NLX_ORGANIZATION_NAME=Conduction
-NLX_ORGANIZATION_UNIT_NAME=Common-Ground
-NLX_COMMON_NAME=zaakonline.nl
-NLX_EMAIL_ADDRESS=[email protected]
-NLX_CHALLANGE_PASSWORD=
+# the duration of the session in seconds
+APP_SESSION_DURATION=900

.github/workflows/artifactRegister.yml

@@ -0,0 +1,56 @@
+name: Artifact Register
+
+on:
+    pull_request:
+        branches:
+            - master
+    push:
+        branches:
+            - master
+
+
+jobs:
+    register:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v1
+            - name: Check if we need to take action
+              id: process
+              run: |
+                  export ARTIFACTHUB_ID=$(grep ARTIFACTHUB_ID= .env | cut -d '=' -f2)
+                  if [ "${{ secrets.ARTIFACT_KEY }}" != "" ] && [ "$ARTIFACTHUB_ID" != "false" ] || [ "ARTIFACTHUB_ID" == "" ]; then
+                    echo "##[set-output name=success;]true"
+                  else
+                    echo "##[set-output name=success;]false"
+                  fi
+            - name: defining variables
+              id: request
+              if: steps.process.outputs.success == 'true'
+              run: |
+                  export HEADER='{"X-API-KEY": "'${{secrets.ARTIFACT_KEY}}'"}'
+                  echo "HEADER=$HEADER" >> $GITHUB_ENV
+                  echo "##[set-output name=header]$HEADER"
+                  echo $HEADER
+                  export USER=$(grep ARTIFACTHUB_USER= .env | cut -d '=' -f2)
+                  if [ $USER != "" ]; then
+                    export URL="https://artifacthub.io/api/v1/repositories/org/$USER"
+                  else
+                    export URL='https://artifacthub.io/api/v1/repositories/user'
+                  fi
+                  echo "URL=$URL" >> $GITHUB_ENV
+                  echo "##[set-output name=url]$URL"
+                  export HELM=$(grep HELM_REPOSITORY= .env | cut -d '=' -f2)
+                  echo "HELM=$HELM" >> $GITHUB_ENV
+                  echo "##[set-output name=helm]$HELM"
+                  export NAME=$(grep APP_NAME_TECHNICAL= .env | cut -d '=' -f2)
+                  echo "NAME=$NAME" >> $GITHUB_ENV
+                  echo "##[set-output name=name]$NAME"
+            - name: Register To Artifact Hub
+              if: steps.process.outputs.success == 'true'
+              uses: satak/webrequest-action@master
+              id: webhook
+              with:
+                  url: https://artifacthub.io/api/v1/repositories/user
+                  method: POST
+                  payload: '{"name": "${{ env.NAME }}", "url": "${{ env.HELM }}"}'
+                  headers: '{"X-API-Key": "${{secrets.ARTIFACT_KEY}}"}'