actions/languageservices
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Separate reusable jobs in the workflow context

Browse Source
This commit is contained in:
Josh Gross
2023-02-03 17:52:48 -05:00
parent 3d5b006138
commit 986ce1bfe4
9 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
actions-languageserver/src/context-providers/secrets.ts
+5 -8
View File
@@ -2,7 +2,6 @@ import {data, DescriptionDictionary} from "@github/actions-expressions";
import {StringData} from "@github/actions-expressions/data/string";
import {WorkflowContext} from "@github/actions-languageservice/context/workflow-context";
import {isMapping, isString} from "@github/actions-workflow-parser";
import {isJob} from "@github/actions-workflow-parser/model/type-guards";
import {Octokit} from "@octokit/rest";
import {RepositoryContext} from "../initializationOptions";
import {TTLCache} from "../utils/cache";
@@ -15,13 +14,11 @@ export async function getSecrets(
defaultContext: DescriptionDictionary | undefined
): Promise<DescriptionDictionary> {
let environmentName: string | undefined;
const job = workflowContext?.job;
const environment = job && isJob(job) && job.environment;
if (environment) {
if (isString(environment)) {
environmentName = environment.value;
} else if (isMapping(environment)) {
for (const x of environment) {
if (workflowContext?.job?.environment) {
if (isString(workflowContext.job.environment)) {
environmentName = workflowContext.job.environment.value;
} else if (isMapping(workflowContext.job.environment)) {
for (const x of workflowContext.job.environment) {
if (isString(x.key) && x.key.value === "name") {
if (isString(x.value)) {
environmentName = x.value.value;
actions-languageserver/src/context-providers/steps.ts
+3 -4
View File
@@ -1,7 +1,7 @@
import {data, DescriptionDictionary, isDescriptionDictionary} from "@github/actions-expressions";
import {parseActionReference} from "@github/actions-languageservice/action";
import {WorkflowContext} from "@github/actions-languageservice/context/workflow-context";
import {isActionStep, isReusableWorkflowJob} from "@github/actions-workflow-parser/model/type-guards";
import {isActionStep} from "@github/actions-workflow-parser/model/type-guards";
import {Octokit} from "@octokit/rest";
import {TTLCache} from "../utils/cache";
import {getActionOutputs} from "./action-outputs";
@@ -12,8 +12,7 @@ export async function getStepsContext(
defaultContext: DescriptionDictionary | undefined,
workflowContext: WorkflowContext
): Promise<DescriptionDictionary | undefined> {
const job = workflowContext.job;
if (!defaultContext || !job || isReusableWorkflowJob(job)) {
if (!defaultContext || !workflowContext.job) {
return defaultContext;
}
@@ -27,7 +26,7 @@ export async function getStepsContext(
// Copy the default context for each step
// If the step is an action, add the action outputs to the context
const stepsContext = new DescriptionDictionary();
for (const step of job.steps) {
for (const step of workflowContext.job.steps) {
if (!contextSteps.has(step.id)) {
continue;
}
actions-languageserver/src/context-providers/variables.ts
+5 -8
View File
@@ -6,7 +6,6 @@ import {Pair} from "@github/actions-expressions/data/expressiondata";
import {RepositoryContext} from "../initializationOptions";
import {StringData} from "@github/actions-expressions/data/index";
import {TTLCache} from "../utils/cache";
import {isJob} from "@github/actions-workflow-parser/model/type-guards";
export async function getVariables(
workflowContext: WorkflowContext,
@@ -16,13 +15,11 @@ export async function getVariables(
defaultContext: DescriptionDictionary | undefined
): Promise<DescriptionDictionary | undefined> {
let environmentName: string | undefined;
const job = workflowContext?.job;
const environment = job && isJob(job) && job.environment;
if (environment) {
if (isString(environment)) {
environmentName = environment.value;
} else if (isMapping(environment)) {
for (const x of environment) {
if (workflowContext?.job?.environment) {
if (isString(workflowContext.job.environment)) {
environmentName = workflowContext.job.environment.value;
} else if (isMapping(workflowContext.job.environment)) {
for (const x of workflowContext.job.environment) {
if (isString(x.key) && x.key.value === "name") {
if (isString(x.value)) {
environmentName = x.value.value;
actions-languageserver/src/test-utils/workflow-context.ts
+2 -3
View File
@@ -1,6 +1,5 @@
import {WorkflowContext} from "@github/actions-languageservice/context/workflow-context";
import {convertWorkflowTemplate, parseWorkflow, TraceWriter} from "@github/actions-workflow-parser";
import {isJob} from "@github/actions-workflow-parser/model/type-guards";
const nullTrace: TraceWriter = {
info: x => {},
@@ -20,8 +19,8 @@ export function createWorkflowContext(workflow: string, job?: string, stepIndex?
context.job = template.jobs.find(j => j.id.value === job);
}
if (stepIndex !== undefined && context.job && isJob(context.job)) {
context.step = context.job.steps[stepIndex];
if (stepIndex !== undefined) {
context.step = context.job?.steps[stepIndex];
}
return context;
actions-languageservice/src/context-providers/env.ts
+2 -4
View File
@@ -1,6 +1,5 @@
import {data, DescriptionDictionary} from "@github/actions-expressions";
import {isScalar, isString} from "@github/actions-workflow-parser";
import {isJob} from "@github/actions-workflow-parser/model/type-guards";
import {MappingToken} from "@github/actions-workflow-parser/templates/tokens/mapping-token";
import {WorkflowContext} from "../context/workflow-context";
@@ -13,9 +12,8 @@ export function getEnvContext(workflowContext: WorkflowContext): DescriptionDict
}
//job env
const job = workflowContext.job;
if (job && isJob(job) && job.env) {
envContext(job.env, d);
if (workflowContext.job && workflowContext.job.env) {
envContext(workflowContext.job.env, d);
}
//workflow env
actions-languageservice/src/context-providers/job.ts
+1 -2
View File
@@ -1,6 +1,5 @@
import {data, DescriptionDictionary} from "@github/actions-expressions";
import {isMapping, isSequence} from "@github/actions-workflow-parser";
import {isReusableWorkflowJob} from "@github/actions-workflow-parser/model/type-guards";
import {MappingToken} from "@github/actions-workflow-parser/templates/tokens/mapping-token";
import {WorkflowContext} from "../context/workflow-context";
@@ -8,7 +7,7 @@ export function getJobContext(workflowContext: WorkflowContext): DescriptionDict
// https://docs.github.com/en/actions/learn-github-actions/contexts#job-context
const jobContext = new DescriptionDictionary();
const job = workflowContext.job;
if (!job || isReusableWorkflowJob(job)) {
if (!job) {
return jobContext;
}
actions-languageservice/src/context-providers/needs.ts
+3 -2
View File
@@ -25,14 +25,15 @@ function needsJobContext(job?: WorkflowJob): DescriptionDictionary {
if (job && isJob(job)) {
d.add("outputs", jobOutputs(job));
}
// Can be "success", "failure", "cancelled", or "skipped"
d.add("result", new data.Null());
return d;
}
function jobOutputs(job: Job): DescriptionDictionary {
function jobOutputs(job?: Job): DescriptionDictionary {
const d = new DescriptionDictionary();
if (!job.outputs) {
if (!job?.outputs) {
return d;
}
actions-languageservice/src/context-providers/steps.ts
+1 -2
View File
@@ -1,12 +1,11 @@
import {data, DescriptionDictionary} from "@github/actions-expressions";
import {isReusableWorkflowJob} from "@github/actions-workflow-parser/model/type-guards";
import {Step} from "@github/actions-workflow-parser/model/workflow-template";
import {WorkflowContext} from "../context/workflow-context";
import {getDescription} from "./descriptions";
export function getStepsContext(workflowContext: WorkflowContext): DescriptionDictionary {
const d = new DescriptionDictionary();
if (!workflowContext.job || isReusableWorkflowJob(workflowContext.job)) {
if (!workflowContext.job?.steps) {
return d;
}
actions-languageservice/src/context/workflow-context.ts
+15 -4
View File
@@ -1,6 +1,6 @@
import {isMapping, isSequence, WorkflowTemplate} from "@github/actions-workflow-parser";
import {isJob, isReusableWorkflowJob} from "@github/actions-workflow-parser/model/type-guards";
import {Step, WorkflowJob} from "@github/actions-workflow-parser/model/workflow-template";
import {Step, Job, ReusableWorkflowJob} from "@github/actions-workflow-parser/model/workflow-template";
import {MappingToken} from "@github/actions-workflow-parser/templates/tokens/mapping-token";
import {SequenceToken} from "@github/actions-workflow-parser/templates/tokens/sequence-token";
import {StringToken} from "@github/actions-workflow-parser/templates/tokens/string-token";
@@ -11,8 +11,11 @@ export interface WorkflowContext {
template: WorkflowTemplate | undefined;
/** If the context is for a position within a job, this will be the job */
job?: WorkflowJob;
/** If the context is for a position within a regular job, this will be the job */
job?: Job;
/** If the context is for a position within a reusable workflow job, this will be the reusable workflow job */
reusableWorkflowJob?: ReusableWorkflowJob;
/** If the context is for a position within a step, this will be the step */
step?: Step;
@@ -36,7 +39,15 @@ export function getWorkflowContext(
switch (token.definition?.key) {
case "job": {
const jobID = (token as StringToken).value;
context.job = template.jobs.find(job => job.id.value === jobID);
const job = template.jobs.find(job => job.id.value === jobID);
if (!job) {
break;
}
if (isJob(job)) {
context.job = job;
} else if (isReusableWorkflowJob(job)) {
context.reusableWorkflowJob = job;
}
break;
}
case "steps": {