> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# italia/publiccode-parser

Validate publiccode.yml files


## Commands

### validate

Check your publiccode.yml validity


| Parameter | Type | Default | Description |
|---|---|---|---|
| `filename` | string | publiccode.yml | Name of the publiccode file |
| `no-network` | boolean | false | Disable checks that require network connections (URL existence and oEmbed). This makes the validation much faster.
 |
| `no-strict` | boolean | false | Disable strict mode. |
| `path` | string | . | Absolute or relative path to the directory containing the repository where the publiccode.yml is located. Defaults to the working directory.
 |
| `remote-base-url` | string |  | The URL pointing to the directory where the publiccode.yml file is located.
 |

## Jobs

### validate

Check publiccode.yml validity


| Parameter | Type | Default | Description |
|---|---|---|---|
| `filename` | string | publiccode.yml | Name of the publiccode file |
| `no-network` | boolean | false | Disables checks that require network connections (URL existence and oEmbed). This makes validation much faster.
 |
| `no-strict` | boolean | false | Disable strict mode. |
| `path` | string |  | An absolute or relative path pointing to a locally cloned repository where the publiccode.yml is located.
 |
| `remote-base-url` | string |  | The URL pointing to the directory where the publiccode.yml file is located.
 |

## Executors

### publiccode-parser-go

publiccode-parser-go image


## Examples

### validate

Validate publiccode.yml at the root of the project


```yaml
version: '2.1'
orbs:
  publiccode-parser: italia/publiccode-parser@1.2.3
workflows:
  examples:
    jobs:
      - publiccode-parser/validate
```

### validate-remote

Validate remote publiccode.yml


```yaml
version: '2.1'
orbs:
  publiccode-parser: italia/publiccode-parser@1.2.3
workflows:
  examples:
    jobs:
      - publiccode-parser/validate:
          remote-base-url: https://raw.githubusercontent.com/<user>/<repo>/main/publiccode.yml
```

### validate-with-path

Validate publiccode.yml specifing a custom name and directory.


```yaml
version: '2.1'
orbs:
  publiccode-parser: italia/publiccode-parser@1.2.3
workflows:
  examples:
    jobs:
      - publiccode-parser/validate:
          filename: publiccode-production.yml
          path: files/publiccodes
```