feat: :art: :sparkles: UI draft for Zenodo workflow

slugb0t commented 1 month ago

Summary by Sourcery

Implement a draft UI for the Zenodo workflow, introducing new components for metadata and license confirmation, and refactor the release page to improve user experience. Add support for Zenodo archival in the release process and prepare for Figshare integration.

New Features:

Introduce a new UI component for confirming metadata and license information in the Zenodo workflow, allowing users to edit and confirm these details before proceeding.
Add a new CardIcon component to display icons with titles and edit links, enhancing the UI for metadata and license confirmation.
Implement a new archival template function to facilitate the integration of Zenodo archival in the release process, providing a seamless workflow for users.

Enhancements:

Refactor the Zenodo release page to use collapsible cards for better organization and user experience, including sections for metadata confirmation, Zenodo login, and GitHub release creation.
Update the dashboard to include a new section for Figshare, preparing for future integration of Figshare archival capabilities.

fairdataihub-bot[bot] commented 1 month ago

Thank you for submitting this pull request! We appreciate your contribution to the project. Before we can merge it, we need to review the changes you've made to ensure they align with our code standards and meet the requirements of the project. We'll get back to you as soon as we can with feedback. Thanks again!

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request implements a new UI draft for the Zenodo workflow, enhancing the user experience and adding new features for managing software releases and archival. The changes include a redesigned layout, new components, and improved functionality for confirming metadata, licenses, and creating GitHub releases.

Sequence Diagram

sequenceDiagram
    participant User
    participant UI
    participant API
    participant Database
    User->>UI: Access Zenodo workflow page
    UI->>API: Request repository data
    API->>Database: Fetch license and metadata IDs
    Database-->>API: Return IDs
    API-->>UI: Return repository data with IDs
    UI->>User: Display Zenodo workflow UI
    User->>UI: Confirm metadata and license
    User->>UI: Login to Zenodo
    UI->>API: Create GitHub release
    API->>GitHub: Create release
    GitHub-->>API: Confirm release creation
    API-->>UI: Update UI with release info

File-Level Changes

Change	Details	Files
Redesigned UI for Zenodo workflow	Added new CardCollapsible components for different sections of the workflow Implemented checkboxes for confirming metadata and license Added CardIcon components for visual representation of actions Reorganized the layout of the Zenodo login, deposition selection, and GitHub release creation sections	`ui/pages/dashboard/[owner]/[repo]/release/zenodo.vue`
Updated renderer utility to include archival template	Added applyArchivalTemplate function to the renderer Removed unused functions for codemeta and citation templates Updated import statements to reflect changes	`bot/utils/renderer/index.js`
Moved codemeta and citation template functions to their respective files	Relocated applyCodemetaTemplate function to bot/codemeta/index.js Relocated applyCitationTemplate function to bot/citation/index.js	`bot/codemeta/index.js` `bot/citation/index.js`
Enhanced Zenodo API endpoint to include license and metadata information	Added retrieval of repository ID from GitHub API Implemented queries to fetch license and metadata identifiers from the database Included license and metadata IDs in the API response	`ui/server/api/[owner]/[repo]/release/zenodo/index.get.ts`
Updated dashboard page to include software archival section	Added Zenodo and Figshare cards for software archival Updated section headers with appropriate icons	`ui/pages/dashboard/[owner]/[repo]/index.vue`
Added event listener for release creation in the bot	Implemented handler for 'release.created' event Added check for installation in the database	`bot/index.js`
Created new component for collapsible cards	Implemented CardCollapsible component with toggleable content Added horizontal layout option	`ui/components/card/CardCollapsible.vue`
Implemented archival template functionality	Created applyArchivalTemplate function Added logic to create or update Zenodo deposition entries in the database Generated archive button with link to Zenodo workflow	`bot/archival/index.js`
Created new component for icon cards	Implemented CardIcon component for visual representation of actions Added edit link functionality	`ui/components/card/CardIcon.vue`

Tips and commands

#### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

fairdataihub-bot[bot] commented 1 month ago

Thanks for making updates to your pull request. Our team will take a look and provide feedback as soon as possible. Please wait for any GitHub Actions to complete before editing your pull request. If you have any additional questions or concerns, feel free to let us know. Thank you for your contributions!

fairdataihub-bot[bot] commented 1 month ago

Thanks for closing this pull request! If you have any further questions, please feel free to open a new issue. We are always happy to help!

fairdataihub / codefair-app