https://github.com/italia/publiccode-parser-action

A simple Github action to validate publiccode.yml
https://github.com/italia/publiccode-parser-action

hacktoberfest

Last synced: about 2 months ago
JSON representation

A simple Github action to validate publiccode.yml

• Host: GitHub
• URL: https://github.com/italia/publiccode-parser-action
• Owner: italia
• License: eupl-1.2
• Created: 2020-10-15T21:11:07.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T13:26:59.000Z (3 months ago)
• Last Synced: 2024-07-20T18:22:31.600Z (2 months ago)
• Topics: hacktoberfest
• Language: Shell
• Homepage:
• Size: 27.3 KB
• Stars: 4
• Watchers: 9
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• .github - publiccode-parser-action

README

        
# publiccode.yml parser action for GitHub

[![Join the #publiccode channel](https://img.shields.io/badge/Slack%20channel-%23publiccode-blue.svg?logo=slack)](https://developersitalia.slack.com/messages/CAM3F785T)

[![Get invited](https://slack.developers.italia.it/badge.svg)](https://slack.developers.italia.it/)

A GitHub action based upon the [Go parser and validator](https://github.com/italia/publiccode-parser-go)

for [publiccode.yml](https://github.com/publiccodeyml/publiccode.yml) files.

`publiccode.yml` is an international standard for describing public software, which

should be placed at the root of Free/Libre and Open Source software repositories.

This parser performs syntactic and semantic validation according to the

[official spec](https://yml.publiccode.tools).

## Examples

Include this action in your repo by creating `.github/workflows/publiccode-yml-validation.yml`

and edit where needed:

```yml

on: [pull_request]

jobs:

  publiccode_yml_validation:

    runs-on: ubuntu-latest

    name: publiccode.yml validation

    steps:

    - uses: actions/checkout@v2

    - uses: italia/publiccode-parser-action@v1

      with:

        publiccode: 'publiccode.yml' # relative path to your publiccode.yml

        comment-on-pr: true

      env:

        REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

### No comments in PR

If you don't want this action to report results as comments in the pull request:

```yml

on: [pull_request]

jobs:

  publiccode_yml_validation:

    runs-on: ubuntu-latest

    name: publiccode.yml validation

    steps:

    - uses: actions/checkout@v2

    - uses: italia/publiccode-parser-action@v1

      with:

        publiccode: 'publiccode.yml'

```

## Contributing

Contributing is always appreciated.

Feel free to open issues, fork or submit a Pull Request.

If you want to know more about how to add new fields, check out [CONTRIBUTING.md](CONTRIBUTING.md).

In order to support other country-specific extensions in addition to Italy some

refactoring might be needed.

## Maintainers

This software is maintained by the

[Developers Italia](https://developers.italia.it/) team.

## License

© 2020-present Dipartimento per la Trasformazione Digitale - Presidenza del Consiglio dei

Ministri

Licensed under the EUPL v1.2.

The version control system provides attribution for specific lines of code.

## Remarks

This GitHub Action is published in the GitHub Marketplace.

As such, you can find the [Terms of Service here](https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-marketplace-terms-of-service).

Also, [here](https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement)

you can find the GitHub Marketplace Developer Agreement.