feat: Add missing deployment_status properties #55

martincostello · 2022-03-28T14:05:54Z

Add missing properties to DeploymentStatusEvent
Add missing properties to WorkflowRun

~~I've made an assumption here that the properties for check suite and workflows are nullable.~~ #55 (comment)

I've also omitted the missing actor and triggering_actor properties at this point as I'm not sure what the type should be with respect to the schema and I couldn't see an obvious existing type for it.

Resolves #54.

wolfy1339 · 2022-03-28T14:26:30Z

The Actor types should be of the User type

JamieMagee · 2022-03-29T02:44:20Z

src/Octokit.Webhooks/Models/WorkflowRun.cs

+        [JsonPropertyName("run_started_at")]
+        [JsonConverter(typeof(DateTimeOffsetConverter))]
+        public DateTimeOffset RunStartedAt { get; init; }
+


Missing previous_attempt_url in here¹. I think the definition is going to be:

Suggested change

[JsonPropertyName("previous_attempt_url")]

public string? PreviousAttemptUrl { get; init; };

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L6255-L6259 ↩

Looks like I missed this one because it's a Deployment WorkflowRun¹, rather than a WorkflowRun, so that's why there wasn't a previous_attempt_url in the payload². Should I add a different type that's a subset, or leave it as is where various properties will just be null because they're absent?

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L2231 ↩

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L2156-L2159 ↩

If octokit/webhooks splits these as two different models, then we should probably do so too.

DeploymentWorkflowRun is used in DeploymentCreatedEvent and DeploymentStatusCreatedEvent.
WorkflowRun is used in WorkflowRunCompletedEvent and WorkflowRunRequestedEvent

Schema reference¹

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L6255-L6259 ↩

I went through the schema definition and added the different models for the ones where they were either defined differently or inline as separate models/enums and rebased this onto #52.

src/Octokit.Webhooks/Events/DeploymentStatusEvent.cs

- Add missing properties to DeploymentStatusEvent - Add missing properties to WorkflowRun Contributes to octokit#54.

Add the `actor` and `triggering_actor` properties to WorkflowRun.

- Add missing `previous_attempt_url` property. - Sort properties according to the schema.

- Add missing properties/types for the `deployment` and `deployment_status` events. - Use dedicated types for `deployment_status`. - Add missing deployment event to `CheckRun`. - Add missing `environment_url` and `log_url` properties to `DeploymentStatus`.

martincostello · 2022-03-31T10:00:41Z

src/Octokit.Webhooks/Events/DeploymentEvent.cs

+        [JsonPropertyName("workflow")]
+        public Models.Workflow? Workflow { get; init; } = null!;
+
+        [JsonPropertyName("workflow_run")]
+        public Models.DeploymentEvent.DeploymentWorkflowRun? WorkflowRun { get; init; } = null!;


Schema reference¹

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L2086-L2087 ↩

martincostello · 2022-03-31T10:01:48Z

src/Octokit.Webhooks/Events/DeploymentStatusEvent.cs

+        [JsonPropertyName("check_run")]
+        public Models.DeploymentEvent.DeploymentCheckRun? CheckRun { get; init; }
+
+        [JsonPropertyName("workflow_run")]
+        public Models.DeploymentEvent.DeploymentWorkflowRun? WorkflowRun { get; init; }
+
+        [JsonPropertyName("workflow")]
+        public Models.Workflow? Workflow { get; init; }


Schema reference¹

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L2193-L2232 ↩

martincostello · 2022-03-31T10:10:35Z

src/Octokit.Webhooks/Models/CheckRunEvent/CheckRun.cs

+        [JsonPropertyName("deployment")]
+        public Deployment Deployment { get; init; } = null!;


Schema references¹²³⁴

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L756 ↩

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L1005 ↩

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L1118 ↩

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L1223 ↩

martincostello · 2022-03-31T10:12:32Z

src/Octokit.Webhooks/Models/DeploymentEvent/DeploymentCheckRun.cs

+    using Octokit.Webhooks.Converter;
+
+    [PublicAPI]
+    public sealed record DeploymentCheckRun


Schema reference¹

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L2193-L2230 ↩

martincostello · 2022-03-31T10:14:10Z

src/Octokit.Webhooks/Models/DeploymentEvent/DeploymentCheckRunConclusion.cs

+    using System.Text.Json.Serialization;
+
+    [JsonConverter(typeof(JsonStringEnumMemberConverter))]
+    public enum DeploymentCheckRunConclusion


Schema reference¹

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L2218-L2227 ↩

martincostello · 2022-03-31T10:15:22Z

src/Octokit.Webhooks/Models/DeploymentEvent/DeploymentWorkflowRun.cs

+    using Octokit.Webhooks.Models.CheckRunEvent;
+
+    [PublicAPI]
+    public sealed record DeploymentWorkflowRun


Schema reference¹

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L2130-L2160 ↩

martincostello · 2022-03-31T10:15:54Z

src/Octokit.Webhooks/Models/DeploymentEvent/DeploymentWorkflowRunConclusion.cs

+    using System.Text.Json.Serialization;
+
+    [JsonConverter(typeof(JsonStringEnumMemberConverter))]
+    public enum DeploymentWorkflowRunConclusion


Schema reference¹

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L2139-L2147 ↩

martincostello · 2022-03-31T10:16:29Z

src/Octokit.Webhooks/Models/DeploymentEvent/DeploymentWorkflowRunStatus.cs

+    using System.Text.Json.Serialization;
+
+    [JsonConverter(typeof(JsonStringEnumMemberConverter))]
+    public enum DeploymentWorkflowRunStatus


Schema reference{^1] plus values from #52

martincostello · 2022-03-31T10:17:24Z

src/Octokit.Webhooks/Models/DeploymentStatusEvent/DeploymentStatus.cs

+        [JsonPropertyName("environment_url")]
+        public string? EnvironmentUrl { get; init; }
+
+        [JsonPropertyName("log_url")]
+        public string? LogUrl { get; init; }


Schema reference¹

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L2180-L2181 ↩

martincostello · 2022-03-31T10:18:22Z

src/Octokit.Webhooks/Models/WorkflowRun.cs

+        [JsonPropertyName("run_started_at")]
+        [JsonConverter(typeof(DateTimeOffsetConverter))]
+        public DateTimeOffset RunStartedAt { get; init; }
+


Schema reference¹

Footnotes

https://github.com/octokit/webhooks/blob/d93eebf4c48dc3c36f9c7ceffab356fa444bf9fc/payload-types/schema.d.ts#L6255-L6259 ↩

martincostello · 2022-03-31T10:33:22Z

I've also validated that the event I originally received in my app deserializes without issue using these changes.

JamieMagee reviewed Mar 29, 2022

View reviewed changes

martincostello commented Mar 29, 2022

View reviewed changes

src/Octokit.Webhooks/Events/DeploymentStatusEvent.cs Outdated Show resolved Hide resolved

martincostello added 4 commits March 31, 2022 10:02

feat: Add missing deployment_status properties

3fec238

- Add missing properties to DeploymentStatusEvent - Add missing properties to WorkflowRun Contributes to octokit#54.

feat: Add actor and triggering_actor

9303e1e

Add the `actor` and `triggering_actor` properties to WorkflowRun.

feat: Add previous_attempt_url

57d5ad2

- Add missing `previous_attempt_url` property. - Sort properties according to the schema.

martincostello force-pushed the add-missing-deployment_status-props branch from d8e4e05 to 46fcead Compare March 31, 2022 09:57

martincostello commented Mar 31, 2022

View reviewed changes

JamieMagee merged commit 67d6930 into octokit:main Mar 31, 2022

martincostello deleted the add-missing-deployment_status-props branch March 31, 2022 17:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add missing deployment_status properties #55

feat: Add missing deployment_status properties #55

martincostello commented Mar 28, 2022 •

edited

Loading

wolfy1339 commented Mar 28, 2022

JamieMagee Mar 29, 2022

martincostello Mar 29, 2022

JamieMagee Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello Mar 31, 2022

martincostello commented Mar 31, 2022


	[JsonPropertyName("previous_attempt_url")]
	public string? PreviousAttemptUrl { get; init; };

		[JsonPropertyName("deployment")]
		public Deployment Deployment { get; init; } = null!;

feat: Add missing deployment_status properties #55

feat: Add missing deployment_status properties #55

Conversation

martincostello commented Mar 28, 2022 • edited Loading

wolfy1339 commented Mar 28, 2022

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Footnotes

Choose a reason for hiding this comment

Footnotes

martincostello commented Mar 31, 2022

martincostello commented Mar 28, 2022 •

edited

Loading