awesome-codegouvfr-tooling's Introduction

Awesome codegouvfr: the tooling API

This repository provides tooling for Awesome CodeGouvFr.

E.g. given a repository, it can generate a first draft of its publiccode.yml file.

Quickstart

npm install
npm start

Generate `publiccode.yml`

After you quickstarted as explained above, here is how to generate a publiccode.yml file given a repository URL, with automatic completion of certain fields from the ecosyste.ms summary API:

# Generate publiccode.yml for react-dsfr project
curl http://localhost:3000/publiccode?repository_url=https://github.com/codegouvfr/react-dsfr

Accepted URLs are all those who return data on summary.ecosyste.ms.

License

Code in this respository is published under the MIT License.

awesome-codegouvfr-tooling's People

Contributors

Watchers

awesome-codegouvfr-tooling's Issues

TypeError: Cannot read properties of null (reading 'full_name')

J'ai essayé d'utiliser le générateur mais quand je lance la commande
de génération (requete curl) avec cette adresse : curl http://localhost:3000/publiccode?repository_url=https://github.com/EsupPortail/Esup-Pod/

voici l'erreur générée :

Server listening on port 3000
TypeError: Cannot read properties of null (reading 'full_name')
    at ecosystemToPubliccodeMapping (/tmp/
awesome-codegouvfr-tooling/tools.js:39:36)
    at Object.ecosystemToPubliccode (/tmp/
awesome-codegouvfr-tooling/tools.js:114:28)
    at process.processTicksAndRejections (node:internal/process/
task_queues:95:5)

Explain the purpose of this tooling

New API endpoint: generate repository template with files

Create a new API endpoint to generate a repository template with the required and optional files such as README, CONTRIBUTING, etc.

Allow publiccode.yml synchronisation

This API currently only creates a publiccode.yml file from scratch. It would be nice to be able to synchronise an existing publiccode.yml with fresher data.