Merge branch 'documentation' into main

Author: rubenvdlinde

README.md

@@ -9,6 +9,9 @@ To use this action, simply include it as a step in your workflow file. No inputs
 ````yaml
 name: My PublicCode Workflow
 
+permissions:
+  contents: write
+  
 on:
   push:
     branches:
@@ -24,30 +27,38 @@ jobs:
 
 In the above example a `publiccode` file is updated every time code on the `main` branche is touched
 
-> **Warning**
-> If you do not supply the action with an access token or an SSH key, you must access your repositories settings and provide `Read and Write Permissions` to the provided `GITHUB_TOKEN`, otherwise you'll potentially run into permission issues. Alternatively you can set the following in your workflow file to grant the action the permissions it needs.
+> **Info**
+> Alternatively to setting the write permission for the workflow, you can also supply the action with an access token or an SSH key; see inputs for more details.
+
+## Working with protected branches
+It is common (and good) practise to protect the main branche of a repository from direct file editing and only allowing this trough pull requests. This will however couse the action (and workflow containing it) to fail becouse the workflow won't have the rights to actually write or create the resulting publiccode or opencatalogi files to the repository.
+
+The sollution here is two run the action two time's
+1- Once on the protected branche with the setting `save` set on false to prevent actual file creation or allteration
+2- Once on a branche where files may actually be added without a pull request (normally dev or development) setting `federlize` set on false to prevent unnececcery upates to the network
 
-```yml
-permissions:
-  contents: write
-```
 
 ## Inputs
 
-| Input Name   | Description                                                  | Default Value        |
-|--------------|--------------------------------------------------------------|-----------------------|
-| `name` | Git URL of the remote repository to check (Optional)         | {{ github.event.repository.name }}"         |
-| `description` | Git URL of the remote repository to check (Optional)         | Empty String          |
-| `remoterepo` | Git URL of the remote repository to check (Optional)         | Empty String          |
-| `publiccode` | `publiccode.yml` path (Optional), e.g. `data/publiccode.yml` | `publiccode.yml`      |
-| `gitname`    | Git name configuration for bump commit (Optional)            | `Open Catalogi bot`  |
-| `gitmail`    | Git mail configuration for bump commit (Optional)            | `bot@opencatalogi.nl` |
+| Input Name   | Description                                                  | Default Value                            |
+|--------------|--------------------------------------------------------------|------------------------------------------|
+| `name` | Git URL of the remote repository to check (Optional)         | {{ github.event.repository.name }} <br/> |
+| `description` | Git URL of the remote repository to check (Optional)         | Empty String                             |
+| `remoterepo` | Git URL of the remote repository to check (Optional)         | Empty String                             |
+| `publiccode` | `publiccode.yml` path (Optional), e.g. `data/publiccode.yml` | `publiccode.yml`                         |
+| `federlize` | Wheter to send an update event to the federilized open catalogi network | true                                     |
+| `save` | Wheter to actually save the file to github | true                                     |
+| `gitname`    | Git name configuration for bump commit (Optional)            | `Open Catalogi bot`                      |
+| `gitmail`    | Git mail configuration for bump commit (Optional)            | `bot@opencatalogi.nl`                    |
 
 example ussage of the inputs
 
 ````yaml
 name: My PublicCode Workflow
 
+permissions:
+  contents: write
+  
 on:
   push:
     branches:
@@ -98,6 +109,9 @@ Need a quick way to present your project online but don't have the time te creat
 ````yaml
 name: My PublicCode Workflow
 
+permissions:
+  contents: write
+  
 on:
   push:
     branches:
@@ -110,7 +124,7 @@ jobs:
       - name: Update publiccode.yaml
         uses: OpenCatalogi/publiccode-action@1.2.1
       - name: Deploy Product Github Page
-        uses: OpenCatalogi/productpage-action@1
+        uses: OpenCatalogi/productpage-action@1.0.0
 ````
 
 [Read more](https://github.com/marketplace/actions/create-an-product-page) about the product  page action 

action.yaml

@@ -22,6 +22,16 @@ inputs:
     required: false
     type: boolean
     default: false
+  federlize:
+    description: 'Wheter to send an update event to the federilized open catalogi network'
+    required: false
+    type: boolean
+    default: true
+  save:
+    description: 'Wheter to actually save the file to github'
+    required: false
+    type: boolean
+    default: true
   # git configuration
   git-name:
     description: 'Git name configuration for the commit'
@@ -263,7 +273,7 @@ runs:
 
     # Commit changes if it is a normal repository
     - name: Commit changes
-      if: (!contains(github.repository, '.github'))
+      if: (!contains(github.repository, '.github') && inputs.save)
       shell: bash
       run: |
         git config --local user.email "${{ inputs.git-mail }}"
@@ -274,7 +284,7 @@ runs:
         git push
     # Commit changes if it is an organisation repository
     - name: Commit changes
-      if: (contains(github.repository, '.github'))
+      if: (contains(github.repository, '.github') && inputs.save)
       shell: bash
       run: |
         git config --local user.email "${{ inputs.git-mail }}"
@@ -285,6 +295,7 @@ runs:
         git push
     # Post Repository URL to OpenCatalogi API
     - name: Post Repository URL to OpenCatalogi API
+      if: (inputs.federlize)
       shell: bash
       run: |
         curl -X POST "https://api.opencatalogi.nl/api/github_events" \