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.

Sign up for GitHub

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

Jump to bottom

fix: refactor workflow_job.queued event to use the WorkflowJob common shema #657

Merged
merged 2 commits into from Jul 5, 2022
Merged

fix: refactor workflow_job.queued event to use the WorkflowJob common shema #657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8a982f
feat: Refactor workflow_job queued event
Helcaraxan Jul 5, 2022
3417898
Regenerate types with proper version of deps
wolfy1339 Jul 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 1 addition & 2 deletions payload-schemas/api.github.com/common/workflow-job.schema.json
View file
Open in desktop
Expand Up @@ -43,8 +43,7 @@
},
"steps": {
"type": "array",
"items": { "$ref": "workflow-step.schema.json" },
"minItems": 1
"items": { "$ref": "workflow-step.schema.json" }
},
"conclusion": {
"type": ["string", "null"],
Expand Down
60 changes: 11 additions & 49 deletions payload-schemas/api.github.com/workflow_job/queued.schema.json
View file
Open in desktop
Expand Up @@ -10,55 +10,17 @@
"repository": { "$ref": "common/repository.schema.json" },
"sender": { "$ref": "common/user.schema.json" },
"workflow_job": {
"type": "object",
"required": [
"id",
"run_id",
"run_url",
"run_attempt",
"node_id",
"head_sha",
"url",
"html_url",
"status",
"conclusion",
"started_at",
"completed_at",
"name",
"steps",
"check_run_url",
"labels",
"runner_id",
"runner_name",
"runner_group_id",
"runner_group_name"
],
"properties": {
"id": { "type": "integer" },
"run_id": { "type": "number" },
"run_url": { "type": "string", "format": "uri" },
"run_attempt": { "type": "integer" },
"head_sha": { "type": "string" },
"node_id": { "type": "string" },
"name": { "type": "string" },
"check_run_url": { "type": "string", "format": "uri" },
"html_url": { "type": "string", "format": "uri" },
"url": { "type": "string", "format": "uri" },
"status": { "type": "string", "enum": ["queued"] },
"steps": {
"type": "array",
"items": { "$ref": "common/workflow-step.schema.json" }
},
"conclusion": { "type": "null" },
"labels": { "type": "array", "items": { "type": "string" } },
"runner_id": { "type": ["integer", "null"] },
"runner_name": { "type": ["string", "null"] },
"runner_group_id": { "type": ["integer", "null"] },
"runner_group_name": { "type": ["string", "null"] },
"started_at": { "type": "string", "format": "date-time" },
"completed_at": { "type": "null" }
},
"additionalProperties": false
"allOf": [
{ "$ref": "common/workflow-job.schema.json" },
{
"type": "object",
"required": ["status"],
"properties": {
"status": { "type": "string", "enum": ["queued"] }
},
"tsAdditionalProperties": false
}
]
}
},
"additionalProperties": false,
Expand Down
26 changes: 2 additions & 24 deletions payload-types/schema.d.ts
View file
Open in desktop
Expand Up @@ -6256,10 +6256,7 @@ export interface WorkflowJob {
* The current status of the job. Can be `queued`, `in_progress`, or `completed`.
*/
status: "queued" | "in_progress" | "completed";
/**
* @minItems 1
*/
steps: [WorkflowStep, ...WorkflowStep[]];
steps: WorkflowStep[];
conclusion: "success" | "failure" | "cancelled" | "skipped" | null;
/**
* Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.
Expand Down Expand Up @@ -6316,27 +6313,8 @@ export interface WorkflowJobQueuedEvent {
installation?: InstallationLite;
repository: Repository;
sender: User;
workflow_job: {
id: number;
run_id: number;
run_url: string;
run_attempt: number;
head_sha: string;
node_id: string;
name: string;
check_run_url: string;
html_url: string;
url: string;
workflow_job: WorkflowJob & {
status: "queued";
steps: WorkflowStep[];
conclusion: null;
labels: string[];
runner_id: number | null;
runner_name: string | null;
runner_group_id: number | null;
runner_group_name: string | null;
started_at: string;
completed_at: null;
};
}
export interface WorkflowRunCompletedEvent {
Expand Down