github: github integration

[alejandromumo]

Taken from https://github.com/zenodo/rdm-project/issues/10

Tasks

Beta Give feedback

1. Update invenio-webhook backend invenio-webhooks#65
   +0
2. Refactor invenio-github backend invenio-github#98
   +0
   
3. github: added alembic upgrade recipes invenio-github#117
   +0
4. dependencies: cleanup dependencies invenio-github#102
   +0
5. Refactor invenio-github UI #2281
   +0
6. metadata: citation file is not being parsed invenio-github#112
   +0
7. github: add zenodo.json compatibility zenodo/zenodo-rdm#407
   +0
8. github: update badges to new module's invenio-github#101
   +0
9. invenio-github docs: add module documentation invenio-github#100
   +0
10. ui: update badges to new module's invenio-github#114
    +0
11. ui: overall improve ui for the feature (ui approved) invenio-github#115
    +0

Documentation

I have drafted a temporary doc using a CodiMD. To be moved to a proper documentation format after we finish the epic.

Specifications

• • Users connect their GitHub accounts via OAuth
• User and organization repositories list fetched to populate GitHub settings page; synchronized every 24h or on demand
• Webhooks created on repository enabling
• On a new (pre)release publish:
  • Event payload received on Zenodo
  • Metadata fetched for the release
    • From basic information (release title, version tag, authors, links)
    • From metadata files like .zenodo.json and CITATION.cff
  • ZIP ball file of the release downloaded
  • New version record is published with metadata and ZIP ball file
• Release history tracked in GitHub settings for each repository
• Release errors retried and tracked
• Still possible to create "manual" versions, or have drafts in progress that don't interrupt the workflow
• GitHub DOI badge always pointing to the latest DOI/version
• GitHub Settings UI pages (repositories list and repository releases) contain some interactive elements currently implemented with jQuery
  • Toggle button for enabling/disabling integration for repositories
  • "Sync now..." button, triggering repositories fetch from the GitHub API

Prerequisites

• All metadata fields have to be part of the record/deposit schema (since they can be included in .zenodo.json files)

Next steps

1. Webhooks module review and integration + GPL -> MIT
2. GitHub module review and integration + GPL -> MIT
   a. Fully working backend and programmatic API
   b. Metadata extraction and mapping (translation of .zenodo.json, and updated CITATION.cff mapping) to InvenioRDM datamodel
   c. Integrate publishing step with the RDMRecord service
3. Migration (and possible rewrite) of interactive UI parts into React

Nice to haves:

• Admin for new admin interface
• REST API to support new admin interface + permissions

Current

CITATION.cff generation

Future

[github-actions]

This issue was automatically marked as stale.

[github-actions]

This issue was automatically marked as stale.

[alejandromumo]

Closing this issue since the feature was already migrated to RDM.

Still is missing docs, but that is being tracked separately as part of the v12 release