Skip to content

Commit 4e0b5bf

Browse files
l2andlnhsinghkatmayb
authored
improve: clarify GitHub Admin responsibilities for CICD (#1751)
## Overview Added notes and clarity to the article to walk GitHub admins who are not in LangSmith how to go through the OAUTH process. (also fixed indentations from double space to 4-space) ## Type of change **Type:** Update existing documentation / formatting <!-- For LangChain employees, if applicable: --> - Linear issue: - Slack thread: https://langchain.slack.com/archives/C09J6LBBUHL ## Checklist <!-- Put an 'x' in all boxes that apply --> - [x] I have read the [contributing guidelines](README.md) - [x] I have tested my changes locally using `docs dev` - [x] All code examples have been tested and work correctly - [x] I have used **root relative** paths for internal links - [x] I have updated navigation in `src/docs.json` if needed --------- Co-authored-by: Lauren Hirata Singh <lauren@langchain.dev> Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
1 parent e9764dc commit 4e0b5bf

File tree

1 file changed

+29
-24
lines changed

1 file changed

+29
-24
lines changed

src/langsmith/deploy-to-cloud.mdx

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,29 +19,34 @@ Before setting up, review the [Cloud overview page](/langsmith/cloud) to underst
1919
1. LangSmith applications are deployed from GitHub repositories. Configure and upload a LangSmith application to a GitHub repository in order to deploy it to LangSmith.
2020
2. [Verify that the LangGraph API runs locally](/langsmith/local-server). If the API does not run successfully (i.e. `langgraph dev`), deploying to LangSmith will fail as well.
2121

22+
<Note>
23+
**One-Time Setup Required**: A GitHub organization owner or admin must complete the OAuth flow in the LangSmith UI to authorize the `hosted-langserve` GitHub app. This only needs to be done once per workspace. After the initial OAuth authorization, all developers with deployment permissions can create and manage deployments without requiring GitHub admin access.
24+
</Note>
25+
2226
## Create new deployment
2327

2428
Starting from the <a href="https://smith.langchain.com/" target="_blank">LangSmith UI</a>:
2529

2630
1. In the left-hand navigation panel, select **Deployments**, which contains a list of existing deployments.
2731
2. In the top-right corner, select **+ New Deployment** to create a new deployment.
2832
3. In the `Create New Deployment` panel, fill out the required fields.
29-
1. `Deployment details`
30-
1. Select `Import from GitHub` and follow the GitHub OAuth workflow to install and authorize LangChain's `hosted-langserve` GitHub app to access the selected repositories. After installation is complete, return to the `Create New Deployment` panel and select the GitHub repository to deploy from the dropdown menu. **Note**: The GitHub user installing LangChain's `hosted-langserve` GitHub app must be an [owner](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners) of the organization or account.
31-
2. Specify a name for the deployment.
32-
3. Specify the desired `Git Branch`. A deployment is linked to a branch. When a new revision is created, code for the linked branch will be deployed. The branch can be updated later in the [Deployment Settings](#deployment-settings).
33-
4. Specify the full path to the [LangGraph API config file](/langsmith/cli#configuration-file) including the file name. For example, if the file `langgraph.json` is in the root of the repository, simply specify `langgraph.json`.
34-
5. Check/uncheck checkbox to `Automatically update deployment on push to branch`. If checked, the deployment will automatically be updated when changes are pushed to the specified `Git Branch`. This setting can be enabled/disabled later in the [Deployment Settings](#deployment-settings).
35-
2. Select the desired `Deployment Type`.
36-
1. `Development` deployments are meant for non-production use cases and are provisioned with minimal resources.
37-
2. `Production` deployments can serve up to 500 requests/second and are provisioned with highly available storage with automatic backups.
38-
3. Determine if the deployment should be `Shareable through Studio`.
39-
1. If unchecked, the deployment will only be accessible with a valid LangSmith API key for the workspace.
40-
2. If checked, the deployment will be accessible through Studio to any LangSmith user. A direct URL to Studio for the deployment will be provided to share with other LangSmith users.
41-
4. Specify `Environment Variables` and secrets. See the [Environment Variables reference](/langsmith/env-var) to configure additional variables for the deployment.
42-
1. Sensitive values such as API keys (e.g. `OPENAI_API_KEY`) should be specified as secrets.
43-
2. Additional non-secret environment variables can be specified as well.
44-
5. A new LangSmith `Tracing Project` is automatically created with the same name as the deployment.
33+
1. `Deployment details`
34+
1. Select `Import from GitHub` and follow the GitHub OAuth workflow to install and authorize LangChain's `hosted-langserve` GitHub app to access the selected repositories. After installation is complete, return to the `Create New Deployment` panel and select the GitHub repository to deploy from the dropdown menu.
35+
<Note> The GitHub user installing LangChain's `hosted-langserve` GitHub app must be an [owner](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners) of the organization or account. This authorization only needs to be completed once per LangSmith workspace - subsequent deployments can be created by any user with deployment permissions.</Note>
36+
2. Specify a name for the deployment.
37+
3. Specify the desired `Git Branch`. A deployment is linked to a branch. When a new revision is created, code for the linked branch will be deployed. The branch can be updated later in the [Deployment Settings](#deployment-settings).
38+
4. Specify the full path to the [LangGraph API config file](/langsmith/cli#configuration-file) including the file name. For example, if the file `langgraph.json` is in the root of the repository, simply specify `langgraph.json`.
39+
5. Use the checkbox to `Automatically update deployment on push to branch`. If checked, the deployment will automatically be updated when changes are pushed to the specified `Git Branch`. This setting can be enabled/disabled later in the [Deployment Settings](#deployment-settings).
40+
2. Select the desired `Deployment Type`.
41+
1. `Development` deployments are meant for non-production use cases and are provisioned with minimal resources.
42+
2. `Production` deployments can serve up to 500 requests/second and are provisioned with highly available storage with automatic backups.
43+
3. Determine if the deployment should be `Shareable through Studio`.
44+
1. If unchecked, the deployment will only be accessible with a valid LangSmith API key for the workspace.
45+
2. If checked, the deployment will be accessible through Studio to any LangSmith user. A direct URL to Studio for the deployment will be provided to share with other LangSmith users.
46+
4. Specify `Environment Variables` and secrets. See the [Environment Variables reference](/langsmith/env-var) to configure additional variables for the deployment.
47+
1. Sensitive values such as API keys (e.g. `OPENAI_API_KEY`) should be specified as secrets.
48+
2. Additional non-secret environment variables can be specified as well.
49+
5. A new LangSmith `Tracing Project` is automatically created with the same name as the deployment.
4550
4. In the top-right corner, select `Submit`. After a few seconds, the `Deployment` view appears and the new deployment will be queued for provisioning.
4651

4752
## Create new revision
@@ -54,14 +59,14 @@ Starting from the <a href="https://smith.langchain.com/" target="_blank">LangSmi
5459
2. Select an existing deployment to create a new revision for.
5560
3. In the `Deployment` view, in the top-right corner, select `+ New Revision`.
5661
4. In the `New Revision` modal, fill out the required fields.
57-
1. Specify the full path to the [LangGraph API config file](/langsmith/cli#configuration-file) including the file name. For example, if the file `langgraph.json` is in the root of the repository, simply specify `langgraph.json`.
58-
2. Determine if the deployment should be `Shareable through Studio`.
59-
1. If unchecked, the deployment will only be accessible with a valid LangSmith API key for the workspace.
60-
2. If checked, the deployment will be accessible through Studio to any LangSmith user. A direct URL to Studio for the deployment will be provided to share with other LangSmith users.
61-
3. Specify `Environment Variables` and secrets. Existing secrets and environment variables are prepopulated. See the [Environment Variables reference](/langsmith/env-var) to configure additional variables for the revision.
62-
1. Add new secrets or environment variables.
63-
2. Remove existing secrets or environment variables.
64-
3. Update the value of existing secrets or environment variables.
62+
1. Specify the full path to the [LangGraph API config file](/langsmith/cli#configuration-file) including the file name. For example, if the file `langgraph.json` is in the root of the repository, simply specify `langgraph.json`.
63+
2. Determine if the deployment should be `Shareable through Studio`.
64+
1. If unchecked, the deployment will only be accessible with a valid LangSmith API key for the workspace.
65+
2. If checked, the deployment will be accessible through Studio to any LangSmith user. A direct URL to Studio for the deployment will be provided to share with other LangSmith users.
66+
3. Specify `Environment Variables` and secrets. Existing secrets and environment variables are prepopulated. See the [Environment Variables reference](/langsmith/env-var) to configure additional variables for the revision.
67+
1. Add new secrets or environment variables.
68+
2. Remove existing secrets or environment variables.
69+
3. Update the value of existing secrets or environment variables.
6570
5. Select `Submit`. After a few seconds, the `New Revision` modal will close and the new revision will be queued for deployment.
6671

6772
## View build and server logs

0 commit comments

Comments
 (0)