Actions in different directory than .github\workflows

[bvandevliet]

Discussed in #207

^{Originally posted by MariuszMielcarski June 1, 2023}
Hi
I have noticed that the plugin successfully found my workflows in .github\workflows directory - and that works great.
But I have some reusable actions defined in other directory, and it was not identified as GitHub actions by the plugin.
Can configure the plugin somehow to add additional directories to track? To have IntelliSense work for my custom actions too.

Wanted to make this an issue as it would also really help out for people like me that run a simple self-hosted Gitea instance, since these workflows are stored in .gitea/workflows. If only there is some setting for the extension that holds an array of workflow paths would be really awesome! Default value would then of course be [".github/workflows"] :)

[felipesu19]

That would be great! Right now this isn't planned, but if someone added it in a PR, I would review it.

[keattang]

@felipesu19 are you able to point me in the direction for how and where I might implement this? It would be very useful for us as we are creating reusable workflows instead of actions in order to get the linting but are finding this is creating a lot of clutter when we look at our workflows in the UI

[felipesu19]

@felipesu19 are you able to point me in the direction for how and where I might implement this? It would be very useful for us as we are creating reusable workflows instead of actions in order to get the linting but are finding this is creating a lot of clutter when we look at our workflows in the UI

I am pretty sure the logic is based on this regex:

vscode-github-actions/src/workflow/documentSelector.ts

Line 2 in 0b6131d

pattern: "**/.github/workflows/*.{yaml,yml}"

I think if you track down where documentSelector is used, you could inject a new regex or just modify the selector.

(Caveat: I have not looked at this in any depth, this is my initial "taking a look at it" impression)

[keattang]

Thanks @felipesu19!

Looking into this further, it seems that the languageservice only knows how to lint workflows and not custom actions. Is this correct? Do you know of a way we can lint custom actions (i.e. action.yaml)?

[ramblingenzyme]

It'd be amazing if we could lint custom actions, both within the .github/actions path, but also when authoring actions. In a repo which publishes an action I wouldn't mind having to override an option to configure VSCode with a different glob.

Even if it was only the expressions parser, that would be super helpful, though I'd imagine that depends on the workflow parser to pull the expressions out in the first place.

[bfondevila]

@felipesu19 are you able to point me in the direction for how and where I might implement this? It would be very useful for us as we are creating reusable workflows instead of actions in order to get the linting but are finding this is creating a lot of clutter when we look at our workflows in the UI

I am pretty sure the logic is based on this regex:

vscode-github-actions/src/workflow/documentSelector.ts

Line 2 in 0b6131d

pattern: "**/.github/workflows/*.{yaml,yml}"

I think if you track down where documentSelector is used, you could inject a new regex or just modify the selector.
(Caveat: I have not looked at this in any depth, this is my initial "taking a look at it" impression)

I believe most people will use the folders "workflows" and "actions", I've not seen anyone suggesting to use any other folder. It would be great to be able to allow users to customize it, but if we confirm that line of code is indeed the only place referencing this folder, I'd suggest to just update this pattern to include both folders:

pattern: "**/.github/{workflows,actions}/*.{yaml,yml}"

But I don't think it's the only place in the code that matters, because based on that glob pattern it wouldn't recognize any yaml file if it was placed in a subfolder of workflows. I can see in the IDE that I can create subfolders inside workflows to any depth and it's picked up correctly by the plugin.

[nathanneibauer]

+1 for this feature request. I am trying to organize a large directory of large workflows into smaller reusable components that I want to store in subfolders. If I uninstall this extension, I can get some support from a yaml schema server, but it's nowhere near the intellisense in GA extension.

[PaulRBerg]

A temporary fix — add this to your VSCode settings:

  "files.associations": {
    "**/actions/*.yml": "github-actions-workflow",
    "**/workflows/*.yml": "github-actions-workflow",
    "**/custom/path/*.yml": "github-actions-workflow",=
  }