[DOCS-1166][DOCS-880][DOCS-1167][DOCS-1168] Update automation docs #1084

mdlinville · 2025-02-05T23:44:31Z

Update all possible links and references to old Model Registry

DOCS-1166

Consolidate project-scoped and model registry automations, new Slack notification flow, ability to edit automations

Note that Automations is enterprise-only

Out of scope:

A followup PR will add details about the new API when it is ready.
Run metrics automations documented in [DOCS-1131] Document run metrics automations #1209

This PR introduces no broken links: https://github.com/wandb/docs/actions/runs/14136418817/job/39609105718

In peer review

Preview links for major changes:

…istry

… registry automations, new Slack notification flow, add redirects

content/guides/models/automations/_index.md

cloudflare-workers-and-pages · 2025-02-05T23:47:10Z

Deploying docs with Cloudflare Pages

Latest commit:	`803b7e2`
Status:	✅ Deploy successful!
Preview URL:	https://6e710725.docodile.pages.dev
Branch Preview URL:	https://automation-updates.docodile.pages.dev

View logs

ssisk

added some comments!

When we do add the docs for run metric events, they need a lot more explanation of how they work than what we have here - we should definitely meet at that time to walk through it

content/guides/hosting/iam/_index.md

content/guides/models/automations/_index.md

tonyyli-wandb

Partway through but have to step away, so wanted to leave any comments I have so far --

content/guides/integrations/huggingface.md

content/guides/integrations/yolov5.md

content/guides/models/automations/_index.md

content/guides/hosting/iam/_index.md

content/guides/models/automations/_index.md

Co-authored-by: Stephen Sisk <[email protected]>

content/guides/models/automations/_index.md

- Move Secrets to new page - Remove mention of run scope - Some of the feedback so far

mdlinville · 2025-03-28T19:34:44Z

See comments in-line.

I think it might be helpful to add some kind of diagram showing the event, action pair options. I attached one Raven originally created but we would want to update it to remove launch jobs and add notification.

It would also be great if we added some more gifs, especially to the multi-step workflows that require you to navigate across parts of the app, like creating a webhook in team settings.

Captured for fast follow

Co-authored-by: Noa <[email protected]>

mdlinville · 2025-03-28T19:36:44Z

Still missing:

example payloads including github actions

structure of post request

test webhook endpoint
but should be unblocked for run metrics notifications

The example payloads are not missing, we discussed offline. The other have been captured to https://wandb.atlassian.net/browse/DOCS-1379

noaleetz

already approved but contains additional feedback to address

content/guides/core/automations/create-automations/webhook.md

ssisk · 2025-03-28T22:14:20Z

content/guides/core/secrets.md

+Specify the secrets you want to use for your webhook automation when you configure the webhook. See the [Configure a webhook]({{< relref "#configure-a-webhook" >}}) section for more information. 
+
+{{% alert %}}
+Once you create a secret, you can access that secret in your W&B workflows with `$`.


it's not totally obvious how to use $ to access - I presume prefixing the name with $? Also, "W&B workflows" aren't really a thing - would automations be a more precise terminology?

Yes, I don't think I introduced this and I wasn't sure what it meant. Now updated.

ssisk · 2025-03-28T22:15:47Z

content/guides/core/secrets.md

+1. Read the confirmation dialog, then click **Delete**. The secret is deleted immediately and permanently.
+
+## Manage access to secrets
+Each member of a team have access to its secrets. To revoke access to a secret from a particular member, remove that member from the team.


if no one can see the contents of a secret, and only admins can create/edit/delete them, what does it mean for a team member to have access to a secret?

Hmm, well a secret is a team-level asset. I guess it means that the team's automations get access to the secret. Let me try again.

ssisk · 2025-03-28T22:29:49Z

content/guides/core/automations/create-automations/webhook.md

+From either of these pages, a Registry admin can manage existing automations:
+- To view an automation's details, click its name.
+- To edit an automation, click its action `...` menu, then click **Edit automation**.
+- To delete an automation, click its action `...` menu, then click **Delete automation**. Confiruation is required.


what does "configuration is required" mean here? I think we can get rid of that?

Confirmation is required. Thanks!

content/guides/core/automations/create-automations/webhook.md

mdlinville · 2025-03-29T00:12:28Z

content/guides/core/automations/create-automations/webhook.md

+From either of these pages, a Registry admin can manage existing automations:
+- To view an automation's details, click its name.
+- To edit an automation, click its action `...` menu, then click **Edit automation**.
+- To delete an automation, click its action `...` menu, then click **Delete automation**. Confiruation is required.


Confirmation is required. Thanks!

mdlinville · 2025-03-29T00:15:03Z

content/guides/core/automations/create-automations/webhook.md

+| `${ACCESS_TOKEN}` | The value of the access token configured in the [webhook integration]({{< relref "#add-a-webhook-integration" >}}), if an access token is configured. The access token is automatically passed in the `Authorization: Bearer` HTTP header. |
+| `${<SECRET>}` | If configured, the value of a secret configured in the [webhook integration]({{< relref "#add-a-webhook-integration" >}}). Replace `<SECRET>` with the name of the secret. |


@ssisk These were previously missing.

content/guides/core/secrets.md

mdlinville · 2025-03-29T00:20:24Z

content/guides/core/secrets.md

+Specify the secrets you want to use for your webhook automation when you configure the webhook. See the [Configure a webhook]({{< relref "#configure-a-webhook" >}}) section for more information. 
+
+{{% alert %}}
+Once you create a secret, you can access that secret in your W&B workflows with `$`.


Yes, I don't think I introduced this and I wasn't sure what it meant. Now updated.

mdlinville · 2025-03-29T00:21:03Z

content/guides/core/secrets.md

+1. Read the confirmation dialog, then click **Delete**. The secret is deleted immediately and permanently.
+
+## Manage access to secrets
+Each member of a team have access to its secrets. To revoke access to a secret from a particular member, remove that member from the team.


Hmm, well a secret is a team-level asset. I guess it means that the team's automations get access to the secret. Let me try again.

content/guides/core/secrets.md

content/guides/core/automations/create-automations/webhook.md

Co-authored-by: Noa <[email protected]>

- Add missing Webhook and Slack Notification sections to Team Settings - In both User and Team settings, note that wandb.alerts also requires an enterprise license

content/_includes/enterprise-only.md

README.md

ngrayluna · 2025-03-31T20:06:30Z

content/guides/core/automations/_index.md


+This page describes _automations_ in W&B. [Create an automation]({{< relref "create-automations/" >}}) to trigger workflow steps, such as automated model testing and deployment, based on an event in W&B, such as when an [artifact]({{< relref "/guides/core/artifacts" >}}) artifact version is created ({{< relref "/guides/core/registry/" >}}).


Link incorrectly formatted.

content/guides/core/automations/_index.md

ngrayluna · 2025-03-31T20:14:43Z

content/guides/core/automations/automation-events.md

+{{< readfile file="/_includes/enterprise-only.md" >}}
+{{% /pageinfo %}}
+
+An automation can run when a specific event occurs at a given scope, either a registry or a project. This page describes the events that can trigger an automation at each scope.


Nit: I try to avoid using "run" if it's not in the context of creating a run. (Unfortunate naming of an object).

content/guides/core/automations/create-automations/webhook.md

content/guides/core/secrets.md

mdlinville · 2025-03-31T21:01:05Z

content/guides/core/automations/_index.md


+This page describes _automations_ in W&B. [Create an automation]({{< relref "create-automations/" >}}) to trigger workflow steps, such as automated model testing and deployment, based on an event in W&B, such as when an [artifact]({{< relref "/guides/core/artifacts" >}}) artifact version is created ({{< relref "/guides/core/registry/" >}}).


content/guides/core/automations/_index.md

content/guides/core/automations/automation-events.md

content/guides/core/automations/create-automations/webhook.md

content/guides/core/secrets.md

content/guides/core/automations/_index.md

Co-authored-by: Noah Luna <[email protected]>

mdlinville added 2 commits February 5, 2025 15:39

[DOCS-1166] Update all possible links and references to old Model Reg…

2e08a16

…istry

[DOCS-880][DOCS-1167][DOCS-1168] Consolidate project-scoped and model…

582d4db

… registry automations, new Slack notification flow, add redirects

mdlinville requested review from ibindlish and tonyyli-wandb February 5, 2025 23:44

mdlinville requested a review from a team as a code owner February 5, 2025 23:44

github-actions bot reviewed Feb 5, 2025

View reviewed changes

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

Style

643b6c3

mdlinville added 4 commits February 5, 2025 15:51

Markdown mistake

064288d

Fix links

f4bfe72

Fix another broken link

0f55a71

Merge remote-tracking branch 'origin/main' into automation_updates

a37335e

mdlinville mentioned this pull request Feb 6, 2025

Archive of proposed changes to automation topics #832

Closed

mdlinville requested a review from ssisk February 6, 2025 19:05

mdlinville added 2 commits February 6, 2025 11:05

Merge branch 'main' into automation_updates

22d0ccc

Merge branch 'main' into automation_updates

db6d7fa

ssisk reviewed Feb 7, 2025

View reviewed changes

mdlinville added 2 commits February 11, 2025 10:02

Merge branch 'main' into automation_updates

5b201a4

Merge remote-tracking branch 'origin/main' into automation_updates

3633fa7

mdlinville commented Feb 11, 2025

View reviewed changes

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

tonyyli-wandb reviewed Feb 11, 2025

View reviewed changes

mdlinville commented Feb 11, 2025

View reviewed changes

content/guides/hosting/iam/_index.md Outdated Show resolved Hide resolved

mdlinville commented Feb 11, 2025

View reviewed changes

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

Stephen's round 1 feedback

7a801c0

Co-authored-by: Stephen Sisk <[email protected]>

github-actions bot reviewed Feb 11, 2025

View reviewed changes

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

mdlinville commented Feb 11, 2025

View reviewed changes

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

mdlinville added 4 commits February 11, 2025 14:36

Apply suggestions from code review

c526e25

Merge remote-tracking branch 'origin/main' into automation_updates

2e74a54

Remove mention of run metrics automations

387b8dd

Feedback

ca18948

- Move Secrets to new page - Remove mention of run scope - Some of the feedback so far

Typo

5ce190d

Update content/guides/core/automations/create-automations/_index.md

001e1a5

Co-authored-by: Noa <[email protected]>

noaleetz reviewed Mar 28, 2025

View reviewed changes

ssisk reviewed Mar 28, 2025

View reviewed changes

ssisk approved these changes Mar 28, 2025

View reviewed changes

mdlinville commented Mar 29, 2025

View reviewed changes

content/guides/core/automations/create-automations/webhook.md Outdated Show resolved Hide resolved

Noa and Stephen's feedback

e16f353

Co-authored-by: Noa <[email protected]>

mdlinville requested a review from ngrayluna March 29, 2025 00:31

mdlinville added 2 commits March 31, 2025 12:24

Add an include for Enterprise Only, use it in the automation pages

39001ee

Update user and team settings

4027246

- Add missing Webhook and Slack Notification sections to Team Settings - In both User and Team settings, note that wandb.alerts also requires an enterprise license

noaleetz approved these changes Mar 31, 2025

View reviewed changes

Revert wandb.alert changes

bd09da6

johndmulhausen reviewed Mar 31, 2025

View reviewed changes

content/_includes/enterprise-only.md Show resolved Hide resolved

johndmulhausen approved these changes Mar 31, 2025

View reviewed changes

Add a Cloud-only include and use it instead

a63fee7

mdlinville commented Mar 31, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

Nit

f46eede

ngrayluna requested changes Mar 31, 2025

View reviewed changes

mdlinville commented Mar 31, 2025

View reviewed changes

content/guides/core/automations/_index.md Outdated Show resolved Hide resolved

Apply suggestions from code review

803b7e2

Co-authored-by: Noah Luna <[email protected]>

mdlinville requested a review from ngrayluna March 31, 2025 21:28

Merge branch 'main' into automation_updates

1e259a1

ngrayluna approved these changes Mar 31, 2025

View reviewed changes

mdlinville merged commit 8ca5621 into main Mar 31, 2025
4 checks passed

mdlinville deleted the automation_updates branch March 31, 2025 22:18

		\| `${ACCESS_TOKEN}` \| The value of the access token configured in the [webhook integration]({{< relref "#add-a-webhook-integration" >}}), if an access token is configured. The access token is automatically passed in the `Authorization: Bearer` HTTP header. \|
		\| `${<SECRET>}` \| If configured, the value of a secret configured in the [webhook integration]({{< relref "#add-a-webhook-integration" >}}). Replace `<SECRET>` with the name of the secret. \|


		This page describes _automations_ in W&B. [Create an automation]({{< relref "create-automations/" >}}) to trigger workflow steps, such as automated model testing and deployment, based on an event in W&B, such as when an [artifact]({{< relref "/guides/core/artifacts" >}}) artifact version is created ({{< relref "/guides/core/registry/" >}}).

[DOCS-1166][DOCS-880][DOCS-1167][DOCS-1168] Update automation docs #1084

[DOCS-1166][DOCS-880][DOCS-1167][DOCS-1168] Update automation docs #1084

Uh oh!

Conversation

mdlinville commented Feb 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented Feb 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying docs with Cloudflare Pages

Uh oh!

ssisk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tonyyli-wandb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mdlinville commented Mar 28, 2025

Uh oh!

mdlinville commented Mar 28, 2025

Uh oh!

noaleetz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

mdlinville commented Feb 5, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Feb 5, 2025 •

edited

Loading