From 0348ab9d5914a833c2468eaef203cfd1a3b6f083 Mon Sep 17 00:00:00 2001 From: Remko Date: Tue, 5 Mar 2024 13:37:09 +0100 Subject: [PATCH 1/2] added more filter options --- README.md | 87 ++++++++++++++++++++++++++++++----------------------- action.yaml | 80 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 130 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index ea735dc..1ac92f7 100644 --- a/README.md +++ b/README.md @@ -53,43 +53,56 @@ permissions: ## Inputs -| Input Name | Description | Required | Type | Default Value | -|------------------------------------|---------------------------------------------------------------------------------------------------------|----------|---------|--------------------------------------------------------------------------| -| `env_vars_set` | Whether to use the env variables set in this file, set to false to use env variables of the OpenCatalogi config files | Yes | boolean | `true` | -| `github_pages_branch` | The branch on which the GitHub page will be built (Optional) | No | string | `gh-pages` | -| `github_repository_name_as_prefix` | Whether to use the GitHub repository name as a prefix (Optional) | No | boolean | `true` | -| `repository` | The GitHub repository to use (could be an external repository) (Optional) | No | string | `${{ github.event.repository.name }}` | -| `pull_from_branche` | The branch on which to base the build (Optional) | No | string | `main` | -| `me_url` | The profile URL used (Optional) | No | string | `https://api.opencatalogi.nl/api/users/me` | -| `api_url` | The location of the Open Catalogi API (change if you are running your own API) (Optional) | No | string | `https://api.opencatalogi.nl/api` | -| `admin_url` | The admin (dashboard) URL used (Optional) | No | string | `https://api.opencatalogi.nl/admin` | -| `base_url` | The BASE location of the Open Catalogi API (change if you are running your own API) (Optional) | No | string | `https://api.opencatalogi.nl` | -| `frontend_url` | The location (URL) of this Open Catalogi installation (Optional) | No | string | `https://api.opencatalogi.nl` | -| `login_redirect` | The path for login redirection (Optional) | No | string | `vault` | -| `admin_dashboard_url` | The location of the Open Catalogi dashboard (Optional) | No | string | `https://admin.opencatalogi.nl` | -| `nl_design_theme_classname` | The class name of the desired NL design theme (Optional) | No | string | `open-webconcept-theme` | -| `arrow_breadcrumbs` | Whether to use arrow breadcrumbs instead of the normal breadcrumbs (Optional) | No | boolean | `false` | -| `start_page` | When given, shows a readme file instead of the normal start page (Optional) | No | string | `false` -| `filter_rating` | What kind of rating must be shown, OpenCatalogi or Commonground (Optional) | No | string | `OpenCatalogi` | -| `favicon_logo` | A base64 encoded SVG file or URL to the logo used as favicon (Optional) | No | string | `https://openwebconcept.nl/wp-content/themes/openwebconcept/assets/src/images/logo@2x.png` | -| `page_title` | The title for the website / gitpage (Optional) | No | string | `${{ github.event.repository.name }}` | -| `navbar_logo` | An base64 encoded SVG file or URL to the logo used in the main menu (Optional) | No | string | `https://openwebconcept.nl/wp-content/themes/openwebconcept/assets/src/images/logo@2x.png` | -| `navbar_show_login` | Shows the inloggen option (Optional) | No | boolean | `false` | -| `navbar_content` | A link to the JSON file that manages the footer content (Optional) | No | string | `https://raw.githubusercontent.com/OpenCatalogi/web-app/348679b7537b20e51767dfdc6086349602afe219/pwa/src/templates/templateParts/header/HeaderContent.json` | -| `jumbotron_title` | The title of the jumbotron (Optional) | No | string | `${{ github.event.repository.name }}` | -| `jumbotron_subtitle` | The (short) subtitle used in the jumbotron (Optional) | No | string | `Product page` | -| `jumbotron_description` | The (long) description included in the jumbotron (Optional) | No | string | `${{ github.event.repository.description }}` | -| `jumbotron_searchform` | Whether or not to display the search form in the jumbotron (Optional) | No | boolean | `false` | -| `jumbotron_iscard` | Put the content of the jumbotron within a card (Optional) | No | boolean | `false` | -| `jumbotron_image_placement` | The position of the jumbotron image ("false", "background","right" ,"left") (Optional) | No | string | `false` | -| `jumbotron_image_url` | An base64 encoded SVG file or URL to the logo used in the jumbotron (Optional) | No | string | `false` | -| `footer_logo` | An base64 encoded SVG file or URL to the logo used in the footer (Optional) | No | string | `https://openwebconcept.nl/wp-content/themes/openwebconcept/assets/src/images/logo@2x.png` | -| `footer_content` | A link to the JSON file that manages the footer content (Optional) | No | string | `https://raw.githubusercontent.com/OpenCatalogi/web-app/25995205e1dbb043822d1c58c5c23f8e6f77ff7e/pwa/src/templates/templateParts/footer/FooterContent.json` | -| `footer_show_creator` | Shows the "With love from conduction" link in the footer (Optional) | No | boolean | `true` | -| `git_name` | Git name configuration for the commit (Optional) | No | string | `Open Catalogi bot` | -| `git_mail` | Git mail configuration for the commit (Optional) | No | string | `bot@opencatalogi.nl` | -| `git_commit_message` | The description for the commit (Optional) | No | string | `${{ github.event.repository.html_url }}` | -| `github_organization_url` | The repository to which the results are limited (used to only look in your own organisation) (Optional) | No | string | `https://github.com/${{ github.repository_owner }}` | +| Input Name | Description | Required | Type | Default Value | +|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `env_vars_set` | Whether to use the env variables set in this file, set to false to use env variables of the OpenCatalogi config files | Yes | boolean | `true` | +| `github_pages_branch` | The branch on which the GitHub page will be built (Optional) | No | string | `gh-pages` | +| `github_repository_name_as_prefix` | Whether to use the GitHub repository name as a prefix (Optional) | No | boolean | `true` | +| `repository` | The GitHub repository to use (could be an external repository) (Optional) | No | string | `${{ github.event.repository.name }}` | +| `pull_from_branche` | The branch on which to base the build (Optional) | No | string | `main` | +| `me_url` | The profile URL used (Optional) | No | string | `https://api.opencatalogi.nl/api/users/me` | +| `api_url` | The location of the Open Catalogi API (change if you are running your own API) (Optional) | No | string | `https://api.opencatalogi.nl/api` | +| `admin_url` | The admin (dashboard) URL used (Optional) | No | string | `https://api.opencatalogi.nl/admin` | +| `base_url` | The BASE location of the Open Catalogi API (change if you are running your own API) (Optional) | No | string | `https://api.opencatalogi.nl` | +| `frontend_url` | The location (URL) of this Open Catalogi installation (Optional) | No | string | `https://api.opencatalogi.nl` | +| `login_redirect` | The path for login redirection (Optional) | No | string | `vault` | +| `admin_dashboard_url` | The location of the Open Catalogi dashboard (Optional) | No | string | `https://admin.opencatalogi.nl` | +| `nl_design_theme_classname` | The class name of the desired NL design theme (Optional) | No | string | `open-webconcept-theme` | +| `arrow_breadcrumbs` | Whether to use arrow breadcrumbs instead of the normal breadcrumbs (Optional) | No | boolean | `false` | +| `start_page` | When given, shows a readme file instead of the normal start page (Optional) | No | string | `false` | +| `filter_forks` | If you want to have the filter forks displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_rating` | What kind of rating must be shown, OpenCatalogi or Commonground (Optional) | No | string | `OpenCatalogi` | +| `filter_layer` | If you want to have the filter layer displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_upl` | If you want to have the filter upl displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_organisation` | If you want to have the filter organisation displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_category` | If you want to have the filter category displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_platforms` | If you want to have the filter platforms displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_status` | If you want to have the filter status displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_maintenance_types` | If you want to have the filter maintenance_types displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_license` | If you want to have the filter license displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_business_functions` | If you want to have the filter business functions displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_software_types` | If you want to have the filter software types displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_business_services` | If you want to have the filter business services displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `filter_reference_components` | If you want to have the filter reference components displayed, set to false to not show the filter (Optional) | No | string | ` ` | +| `favicon_logo` | A base64 encoded SVG file or URL to the logo used as favicon (Optional) | No | string | `https://openwebconcept.nl/wp-content/themes/openwebconcept/assets/src/images/logo@2x.png` | +| `page_title` | The title for the website / gitpage (Optional) | No | string | `${{ github.event.repository.name }}` | +| `navbar_logo` | An base64 encoded SVG file or URL to the logo used in the main menu (Optional) | No | string | `https://openwebconcept.nl/wp-content/themes/openwebconcept/assets/src/images/logo@2x.png` | +| `navbar_show_login` | Shows the inloggen option (Optional) | No | boolean | `false` | +| `navbar_content` | A link to the JSON file that manages the footer content (Optional) | No | string | `https://raw.githubusercontent.com/OpenCatalogi/web-app/348679b7537b20e51767dfdc6086349602afe219/pwa/src/templates/templateParts/header/HeaderContent.json` | +| `jumbotron_title` | The title of the jumbotron (Optional) | No | string | `${{ github.event.repository.name }}` | +| `jumbotron_subtitle` | The (short) subtitle used in the jumbotron (Optional) | No | string | `Product page` | +| `jumbotron_description` | The (long) description included in the jumbotron (Optional) | No | string | `${{ github.event.repository.description }}` | +| `jumbotron_searchform` | Whether or not to display the search form in the jumbotron (Optional) | No | boolean | `false` | +| `jumbotron_iscard` | Put the content of the jumbotron within a card (Optional) | No | boolean | `false` | +| `jumbotron_image_placement` | The position of the jumbotron image ("false", "background","right" ,"left") (Optional) | No | string | `false` | +| `jumbotron_image_url` | An base64 encoded SVG file or URL to the logo used in the jumbotron (Optional) | No | string | `false` | +| `footer_logo` | An base64 encoded SVG file or URL to the logo used in the footer (Optional) | No | string | `https://openwebconcept.nl/wp-content/themes/openwebconcept/assets/src/images/logo@2x.png` | +| `footer_content` | A link to the JSON file that manages the footer content (Optional) | No | string | `https://raw.githubusercontent.com/OpenCatalogi/web-app/25995205e1dbb043822d1c58c5c23f8e6f77ff7e/pwa/src/templates/templateParts/footer/FooterContent.json` | +| `footer_show_creator` | Shows the "With love from conduction" link in the footer (Optional) | No | boolean | `true` | +| `git_name` | Git name configuration for the commit (Optional) | No | string | `Open Catalogi bot` | +| `git_mail` | Git mail configuration for the commit (Optional) | No | string | `bot@opencatalogi.nl` | +| `git_commit_message` | The description for the commit (Optional) | No | string | `${{ github.event.repository.html_url }}` | +| `github_organization_url` | The repository to which the results are limited (used to only look in your own organisation) (Optional) | No | string | `https://github.com/${{ github.repository_owner }}` | diff --git a/action.yaml b/action.yaml index 321b9f6..c9af270 100644 --- a/action.yaml +++ b/action.yaml @@ -28,11 +28,78 @@ inputs: required: false type: string default: 'false' + + # Filter + filter_forks: + description: 'If you want to have the filter forks displayed, set to false to not show the filter' + required: false + type: string + default: ' ' filter_rating: description: 'What kind of rating must be shown, OpenCatalogi or Commonground' required: false type: string default: 'OpenCatalogi' + filter_layer: + description: 'If you want to have the filter layer displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_upl: + description: 'If you want to have the filter upl displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_organisation: + description: 'If you want to have the filter organisation displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_category: + description: 'If you want to have the filter category displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_platforms: + description: 'If you want to have the filter platforms displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_status: + description: 'If you want to have the filter status displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_maintenance_types: + description: 'If you want to have the filter maintenance types displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_license: + description: 'If you want to have the filter license displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_business_fuctions: + description: 'If you want to have the filter business functions displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_software_types: + description: 'If you want to have the filter software types displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_business_services: + description: 'If you want to have the filter business services displayed, set to false to not show the filter' + required: false + type: string + default: ' ' + filter_reference_components: + description: 'If you want to have the filter reference components displayed, set to false to not show the filter' + required: false + type: string + default: ' ' # Header navbar_show_login: @@ -223,7 +290,20 @@ runs: envkey_GATSBY_USE_GITHUB_REPOSITORY_NAME_AS_PATH_PREFIX: ${{ inputs.github_repository_name_as_prefix }} envkey_GATSBY_GITHUB_REPOSITORY_NAME: ${{ inputs.repository }} envkey_GATSBY_OPTIONAL_START_PAGE: ${{ inputs.start_page }} + envkey_GATSBY_FILTER_FORKS: ${{ inputs.filter_forks }} envkey_GATSBY_FILTER_RATING: ${{ inputs.filter_rating }} + envkey_GATSBY_FILTER_LAYER: ${{ inputs.filter_layer }} + envkey_GATSBY_FILTER_UPL: ${{ inputs.filter_upl }} + envkey_GATSBY_FILTER_ORGANISATION: ${{ inputs.filter_organisation }} + envkey_GATSBY_FILTER_CATEGORY: ${{ inputs.filter_category }} + envkey_GATSBY_FILTER_PLATFROMS: ${{ inputs.filter_platforms }} + envkey_GATSBY_FILTER_STATUS: ${{ inputs.filter_status }} + envkey_GATSBY_FILTER_MAINTENANCE_TYPES: ${{ inputs.filter_maintenance_types }} + envkey_GATSBY_FILTER_LICENSE: ${{ inputs.filter_license }} + envkey_GATSBY_FILTER_BUSINESS_FUNCTIONS: ${{ inputs.filter_business_functions }} + envkey_GATSBY_FILTER_SOFTWARE_TYPES: ${{ inputs.filter_types }} + envkey_GATSBY_FILTER_BUSINESS_SERVICES: ${{ inputs.filter_business_services }} + envkey_GATSBY_FILTER_REFERENCE_COMPONENTS: ${{ inputs.filter_reference_components }} envkey_GATSBY_ME_URL: ${{ inputs.me_url }} envkey_GATSBY_API_URL: ${{ inputs.api_url }} envkey_GATSBY_ADMIN_URL: ${{ inputs.admin_url }} From 7f9a30302a069698734c4d717df03075369cf141 Mon Sep 17 00:00:00 2001 From: Remko Date: Tue, 5 Mar 2024 13:37:46 +0100 Subject: [PATCH 2/2] cleanup --- action.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/action.yaml b/action.yaml index c9af270..e2e1405 100644 --- a/action.yaml +++ b/action.yaml @@ -29,7 +29,7 @@ inputs: type: string default: 'false' - # Filter + # Filters filter_forks: description: 'If you want to have the filter forks displayed, set to false to not show the filter' required: false