Skip to content

Template for starting a shared partner repo

License

Notifications You must be signed in to change notification settings

langchain-ai/integration-repo-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🦜️🔗 LangChain {partner}

This repository contains 1 package with {partner} integrations with LangChain:

Initial Repo Checklist (Remove this section after completing)

Welcome to the LangChain Partner Integration Repository! This checklist will help you get started with your new repository.

After creating your repo from the integration-repo-template, we'll go through the following steps:

  1. Setting up your new repository in GitHub

This setup assumes that the partner package is already split. For those instructions, see these docs.

Code (auto ecli)

  • Fill out the readme above (for folks that follow pypi link)

  • Copy package into /libs folder

  • Update these fields in /libs/*/pyproject.toml

    • tool.poetry.repository
    • tool.poetry.urls["Source Code"]

Workflow code (auto ecli)

  • Populate .github/workflows/_release.yml with on.workflow_dispatch.inputs.working-directory.default
  • Configure LIB_DIRS in .github/scripts/check_diff.py

Workflow code (manual)

  • Add secrets as env vars in .github/workflows/_release.yml

Monorepo workflow code (manual)

  • Pull in new code location, remove old in .github/workflows/api_doc_build.yml

In github (manual)

  • Add integration testing secrets in Github (ask Erick for help)
  • Add partner collaborators in Github (ask Erick for help)
  • "Allow auto-merge" in General Settings
  • Only "Allow squash merging" in General Settings
  • Set up ruleset matching CI build (ask Erick for help)
    • name: ci build
    • enforcement: active
    • bypass: write
    • target: default branch
    • rules: restrict deletions, require status checks ("CI Success"), block force pushes
  • Set up ruleset
    • name: require prs
    • enforcement: active
    • bypass: none
    • target: default branch
    • rules: restrict deletions, require a pull request before merging (0 approvals, no boxes), block force pushes

Pypi (manual)

  • Add new repo to test-pypi and pypi trusted publishing (ask Erick for help)

Slack

  • Set up release alerting in Slack (ask Erick for help)

release: /github subscribe langchain-ai/langchain-{partner_lower} releases workflows:{name:"release"} /github unsubscribe langchain-ai/langchain-{partner_lower} issues pulls commits deployments

About

Template for starting a shared partner repo

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published