Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(api): registry1 and package flavor patterns #889

Closed
wants to merge 32 commits into from

Conversation

justinthelaw
Copy link
Contributor

@justinthelaw justinthelaw commented Aug 7, 2024

DESCRIPTION

Caution

DO NOT MERGE

Creates a Registry1 flavor for the LeapfrogAI API and improves documentation on how to use the API. Refactors Make recipes, values files, and other tangential components that are affected by this new multi-Zarf-package-flavor enhancement.

As a side effect of this change, closer alignment to UDS Common and UDS CLI standards and documentation practices were implemented to improve repeatability and developer experience.

This PR closes several issues, and is a direct child of the Epic described here: #750

BREAKING CHANGES

  • Builds:1
    • adds upstream flavor to ALL Zarf packages, as the default
    • remap GHCR repository names to match UDS package standard

CHANGES

  • Builds:1

    • add registry1 flavor to the API package
      • only adds registry1 flavor for api and kiwigrid, does not change api-migrations yet
    • adds unicorn flavor placeholder to the API Zarf package
  • Documentation:2

    • refactors API documentation to provide clearer instructions and pointers
    • adds missing component descriptions in ALL Zarf packages
    • adds markdownlint configuration files for *.md documentation linting
      • fixes all markdownlint errors
  • Tests:3

    • adds stronger and more comprehensive pre-commit checks for Zarf packaging and UDS bundling
    • add UDS, Zarf, Commit, and Labels linting workflows

Footnotes

  1. chore(release): correct ghcr repository directory #703 feat: leapfrogai api registry1 flavor #730 2

  2. chore(docs): markdown and docs linter #711 chore(api): Document supported file types for RAG #754

  3. chore(lint): commit and label lint #709 chore(lint): uds and zarf lints #706

@justinthelaw justinthelaw added documentation Improvements or additions to documentation enhancement New feature or request dependencies Pull requests that update a dependency file api labels Aug 7, 2024
@justinthelaw justinthelaw self-assigned this Aug 7, 2024
@justinthelaw justinthelaw requested a review from a team as a code owner August 7, 2024 19:56
@justinthelaw justinthelaw linked an issue Aug 7, 2024 that may be closed by this pull request
@justinthelaw justinthelaw changed the title (DO NOT MERGE) feat(api): registry1 package flavor [DO NOT MERGE] feat(api): registry1 package flavor Aug 7, 2024
Copy link

netlify bot commented Aug 7, 2024

Deploy Preview for leapfrogai-docs canceled.

Name Link
🔨 Latest commit 3768f78
🔍 Latest deploy log https://app.netlify.com/sites/leapfrogai-docs/deploys/66bf97d3c69af60008265eda

@justinthelaw justinthelaw marked this pull request as draft August 7, 2024 20:12
@justinthelaw justinthelaw changed the title [DO NOT MERGE] feat(api): registry1 package flavor [DO NOT MERGE] feat(api): registry1 and package flavor patterns Aug 7, 2024
@justinthelaw justinthelaw changed the title [DO NOT MERGE] feat(api): registry1 and package flavor patterns feat(api): registry1 and package flavor patterns Aug 7, 2024
@justinthelaw justinthelaw linked an issue Aug 7, 2024 that may be closed by this pull request
@justinthelaw justinthelaw marked this pull request as ready for review August 7, 2024 21:19
@justinthelaw justinthelaw added the blocked 🛑 Something needs to happen before this issues is worked label Aug 8, 2024
@justinthelaw justinthelaw marked this pull request as draft August 8, 2024 16:14
@justinthelaw justinthelaw linked an issue Aug 8, 2024 that may be closed by this pull request
@justinthelaw justinthelaw marked this pull request as ready for review August 8, 2024 19:33
@justinthelaw justinthelaw marked this pull request as draft August 8, 2024 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api blocked 🛑 Something needs to happen before this issues is worked dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant