diff --git a/.github/workflows/version.yml b/.github/workflows/version.yml index 621b633..492a08a 100644 --- a/.github/workflows/version.yml +++ b/.github/workflows/version.yml @@ -6,6 +6,7 @@ on: branches: - master - main + - development jobs: release-managment: @@ -22,7 +23,7 @@ jobs: id: version uses: codacy/git-version@2.7.1 with: - release-branch: master + release-branch: main dev-branch: development - name: Use the version diff --git a/README.md b/README.md index 89e17a6..20be6ab 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ jobs: build: runs-on: ubuntu-latest steps: - - name: Update publiccode.yaml + - name: Deploy Open Catalogi Github Page uses: OpenCatalogi/opencatalogi-action@latest ```` @@ -42,6 +42,15 @@ permissions: contents: write ``` +> **Note** +> When you first run the workflow you need to `manually` activate github pages on your repository! Head over to setting -> pages. Select `deploy form a branch` as a source and `gh-pages` as your branche (unles you configured the page to be build in a differend branche) +> ![Page Settings](docs/page_settings.png) +> Afther pressing save head over tot the actions and take a look at the `pages build and deployment` action +> ![Page Action](docs/page_build.png) +> When it is done it will also tell you under wich link you can find your page +> ![Page Action done](docs/page_build_done.png) + + ## Input | Input Name | Description | Default Value | @@ -69,6 +78,29 @@ permissions: |-----------------|--------------------------------------------------------------------------| | `page` | A zip of the build page | +## Tips +Besides making creating a frontend for your catalogue its also a goed idea to define how your organisation uses open source. Luckily this is verey easilly don by adding the publiccode action to your workflow + +````yaml +name: My PublicCode Workflow + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Deploy Product Github Page + uses: OpenCatalogi/productpage-action@1 + - name: Update opencatalogi.yaml + uses: OpenCatalogi/publiccode-action@1 +```` + +[Read more](https://github.com/marketplace/actions/create-or-update-publiccode-yaml) about the publiccode action that also creates the opencatalogi.yaml + ## Special thanxs As is the case with most software this action is based on the work of others, and uses there code. We would like to give a special shout out to the following parties and thier code @@ -76,10 +108,10 @@ As is the case with most software this action is based on the work of others, an - [SpicyPizza | create-envfile](https://github.com/SpicyPizza/create-envfile). ## Maintainers -This software is maintained by the Developers Italia team. +This software is maintained by [Conduction b.v.](https://conduction.nl/) ## License -© 2022 Gemeente Rotterdam +© 2023 Conduction B.V. Licensed under the EUPL. The version control system provides attribution for specific lines of code. diff --git a/action.yaml b/action.yaml index ac34831..b0478e1 100644 --- a/action.yaml +++ b/action.yaml @@ -10,62 +10,97 @@ inputs: github_pages_branch: description: 'The banche on wish the github page wil be build' required: false + tyoe: string default: 'gh-pages' github_repository_name_as_prefix: description: 'Whether to use the github repository name as a prefix, set to false when using a custom domain' required: false - default: 'true' + tyoe: boolean + default: true repository: description: 'The github repository to use (could be an external repository)' required: false - default: ${{ github.event.repository.url }} + tyoe: string + default: ${{ github.event.repository.name }} me_url: description: 'The me (profile) url used' required: false + tyoe: string default: 'https://api.opencatalogi.nl/api/users/me' api_url: description: 'The location of the open catalogi api (change if you are running your own api)' required: false + tyoe: string default: 'https://api.opencatalogi.nl/api' admin_url: description: 'The admin (dashboard) url used' required: false + tyoe: string default: 'https://api.opencatalogi.nl/admin' base_url: description: 'The BASE location of the open catalogi api (change if you are running your own api)' required: false + tyoe: string default: 'https://api.opencatalogi.nl' frontend_url: description: 'the location (url) of this open catalogi installation' required: false + tyoe: string default: 'https://api.opencatalogi.nl' login_redirect: description: 'publiccode.yml path' required: false + tyoe: string default: 'vault' admin_dashboard_url: description: 'the location of the pen catalogi dashboard' required: false + tyoe: string default: 'https://admin.opencatalogi.nl' nl_design_theme_classname: description: 'the class name of the desired nl design theme' required: false + tyoe: string default: 'open-webconcept-theme' arrow_breadcrumbs: description: 'whether to use arrow breadcrums instead of the normal breadcrumbs' required: false - default: 'false' + tyoe: boolean + default: false navbar_logo: description: 'An base64 encoded svg file or url to the logo used in the main menu' required: false + tyoe: string default: 'https://openwebconcept.nl/wp-content/themes/openwebconcept/assets/src/images/logo@2x.png' + contact_tel: + description: 'A phone number where your organisation is reachable' + required: false + tyoe: string + default: '012-3456789' + contact_email: + description: 'A phone number where your organisation is reachable' + required: false + tyoe: string + default: 'info@openwebconcept.nl' + contact_website: + description: 'A phone number where your organisation is reachable' + required: false + tyoe: string + default: 'https://openwebconcept.nl' + contact_adres: + description: 'A phone number where your organisation is reachable' + required: false + tyoe: string + default: 'Dorpsplein 1, 1000 AA Zuid-drecht' gitname: description: 'Git name configuration for bump commit' required: false + tyoe: string default: 'Open Catalogi bot' gitmail: description: 'Git mail configuration for bump commit' required: false + tyoe: string default: 'bot@opencatalogi.nl' outputs: @@ -97,6 +132,10 @@ runs: envkey_GATSBY_NL_DESIGN_THEME_CLASSNAME: ${{ inputs.nl_design_theme_classname }} envkey_GATSBY_ARROW_BREADCRUMBS: ${{ inputs.arrow_breadcrumbs }} envkey_GATSBY_HEADER_LOGO_URL: ${{ inputs.navbar_logo }} + envkey_GATSBY_CONTACT_TEL: ${{ inputs.contact_tel }} + envkey_GATSBY_CONTACT_EMAIL: ${{ inputs.contact_email }} + envkey_GATSBY_CONTACT_WEBSITE: ${{ inputs.contact_website }} + envkey_GATSBY_CONTACT_ADRES: ${{ inputs.contact_adres }} # envkey_GATSBY_GITHUB_ORGANIZATION_URL: ${{ env.GITHUB_ORGANIZATION_URL }} directory: pwa/static diff --git a/docs/page_build.png b/docs/page_build.png new file mode 100644 index 0000000..e16bae1 Binary files /dev/null and b/docs/page_build.png differ diff --git a/docs/page_build_done.png b/docs/page_build_done.png new file mode 100644 index 0000000..6a1fed5 Binary files /dev/null and b/docs/page_build_done.png differ diff --git a/docs/page_settings.png b/docs/page_settings.png new file mode 100644 index 0000000..11c18ce Binary files /dev/null and b/docs/page_settings.png differ