Skip to content

Commit

Permalink
Merge pull request #2 from OpenCatalogi/development
Browse files Browse the repository at this point in the history
New jumbotron functionality
  • Loading branch information
rubenvdlinde authored Nov 3, 2023
2 parents b03d3ac + 0f2e352 commit 102520b
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 18 deletions.
55 changes: 38 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,44 @@ permissions:

## Input

| Input Name | Description | Default Value |
|------------------------------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------|
| `github_pages_branch` | The branch on which the GitHub page will be built (Optional) | `gh-pages` |
| `github_repository_name_as_prefix` | Whether to use the GitHub repository name as a prefix (Optional) | `true` |
| `repository` | The GitHub repository to use (could be an external repository) (Optional) | `github.event.repository.url` |
| `me_url` | The profile URL used (Optional) | `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) | `https://api.opencatalogi.nl/api` |
| `admin_url` | The admin (dashboard) URL used (Optional) | `https://api.opencatalogi.nl/admin` |
| `base_url` | The BASE location of the Open Catalogi API (change if you are running your own API) (Optional) | `https://api.opencatalogi.nl` |
| `frontend_url` | The location (URL) of this Open Catalogi installation (Optional) | `https://api.opencatalogi.nl` |
| `login_redirect` | The path for login redirection (Optional) | `vault` |
| `admin_dashboard_url` | The location of the Open Catalogi dashboard (Optional) | `https://admin.opencatalogi.nl` |
| `nl_design_theme_classname` | The class name of the desired NL design theme (Optional) | `open-webconcept-theme` |
| `arrow_breadcrumbs` | Whether to use arrow breadcrumbs instead of the normal breadcrumbs (Optional) | `false` |
| `navbar_logo` | A base64 encoded SVG file or URL to the logo used in the main menu (Optional)| `https://openwebconcept.nl/wp-content/themes/openwebconcept/assets/src/images/[email protected]` |
| `gitname` | Git name configuration for bump commit (Optional) | `Open Catalogi bot` |
| `gitmail` | Git mail configuration for bump commit (Optional) | `[email protected]` |
## Inputs

| Input Name | Description | Required | Type | Default Value |
|------------------------------------|---------------------------------------------------------------------------------------------------------|----------|---------|--------------------------------------------------------------------------|
| `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` |
| `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/[email protected]` |
| `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/[email protected]` |
| `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/[email protected]` |
| `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 | `[email protected]` |
| `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 }}` |



## Output
Expand Down
49 changes: 48 additions & 1 deletion action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ inputs:
required: false
type: string
default: 'https://openwebconcept.nl/wp-content/themes/openwebconcept/assets/src/images/[email protected]'
page_title:
description: 'The title for the website / gitpage'
required: false
type: string
default: ${{ github.event.repository.name }}
nl_design_theme_classname:
description: 'the class name of the desired nl design theme'
required: false
Expand Down Expand Up @@ -104,7 +109,43 @@ inputs:
required: false
type: string
default: 'https://raw.githubusercontent.com/OpenCatalogi/web-app/348679b7537b20e51767dfdc6086349602afe219/pwa/src/templates/templateParts/header/HeaderContent.json'

# Jumbotran
jumbotron_title:
description: 'The title of the jumbotron'
required: false
type: string
default: ${{ github.event.repository.name }}
jumbotron_subtitle:
description: 'The (short) subtitle used in the jumbotron'
required: false
type: string
default: 'Product page'
jumbotron_description:
description: 'The (long) description included in the jumbotron)'
required: false
type: string
default: ${{ github.event.repository.description }}
jumbotron_searchform:
description: 'Whether or not to display the search form'
required: false
type: boolean
default: false
jumbotron_iscard:
description: 'Put the content o the jumbotron within a card'
required: false
type: boolean
default: false
jumbotron_image_placement:
description: 'The position of the jumbotron image ("false" | "background" | "right" | "left")'
required: false
type: string
default: "false"
jumbotron_image_url:
description: 'An base64 encoded svg file or url to the logo used in the jumbotron'
required: false
type: string
default: "false"

# Footer
footer_logo:
Expand All @@ -123,7 +164,6 @@ inputs:
type: boolean
default: true


# git configuration
git_name:
description: 'Git name configuration for the commit'
Expand Down Expand Up @@ -188,6 +228,13 @@ runs:
envkey_GATSBY_FOOTER_SHOW_CREATOR: ${{ inputs.footer_show_creator }}
envkey_GATSBY_FOOTER_CONTENT: ${{ inputs.footer_content }}
envkey_GATSBY_GITHUB_ORGANIZATION_URL: ${{ inputs.github_organization_url }}
envkey_GATSBY_JUMBOTRON_TITLE: ${{ inputs.jumbotron_title }}
envkey_GATSBY_JUMBOTRON_SUBTITLE: ${{ inputs.jumbotron_subtitle }}
envkey_GATSBY_JUMBOTRON_DESCRIPTION: ${{ inputs.jumbotron_description }}
envkey_GATSBY_JUMBOTRON_SEARCHFORM: ${{ inputs.jumbotron_searchform }}
envkey_GATSBY_JUMBOTRON_ISCARD: ${{ inputs.jumbotron_iscard }}
envkey_GATSBY_JUMBOTRON_IMAGE_PLACEMENT: ${{ inputs.jumbotron_image_placement }}
envkey_GATSBY_JUMBOTRON_IMAGE_URL: ${{ inputs.jumbotron_image_url }}

directory: pwa/static
file_name: .env.production
Expand Down

0 comments on commit 102520b

Please sign in to comment.