🚧 WIP 🚧, beginning of GitHub Actions language server, powering https://marketplace.visualstudio.com/items?itemName=cschleiden.vscode-github-actions
MIT License
This package provides a parser and various language-server related features for GitHub Actions.
Auto-completion and validation of expressions (e.g., ${{ secrets.FOO }}
) requires information about the repository that contains the workflow as well as an authenticated Octokit client for making API calls.
Some usages examples:
// Workflow text
const input = "on: ..."
const workflowDoc = await parse({
client, // Authenticated Octokit client. Needs at least `repo`, `actions`, and for org-secrets also org admin permissions
owner: "repository-owner",
repository: "repository"
}, input)
// workflowDoc.workflow // Parsed, normalized workflow
// workflowDoc.diagnostics // Errors/warnings
// workflowDoc.workflowST // AST
tbd
tbd
const result = evaluateExpression("${{ env.TEST == 42 }}, {
get(contextName: "github" | "env" | ...) {
if (contextName === "env) {
return {
TEST: 42
};
}
return {};
}
}) // Evaluates to true
lib/expressions
- Parser and evaluator for GitHub Actions workflow expressionslib/parser
- Generic YAML parser with validation and auto-complete supportlib/parser/schema
- TypeScript based YAML schemalib/workflowschema
- GitHub Actions workflow specific parse/complete/hover functions, this is the main exported functionalityIn order to auto-complete and validate parts of the workflow depending on the state of other repositories (Actions being used) or some data in the repository the parser needs to make API calls. The results of the API calls are cached for some time to avoid making too many calls. The cache lives in the imported module, which works well for VS Code, for example, where switching repositories means reloading the editor but could lead to issues if the same instance of the module is used for different repositories.
This library is built on some great open-source projects:
action.yml
files for inputs
auto-completion)