microsoft / microsoft/planetary-computer-tasks

Add workflow linter

Open
#29 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
43
Forks
19
Avg merge
1h 23m
Merged PRs (30d)
1

Description

Is your feature request related to a problem? Please describe.

We should have a linter that validates workflows files, checking for common mistakes prior to submission.

  • verify task is an object like mypackage.mymodule:MyClass. Naive users (cough me cough) might accidentally put mypackage.mymodule.MyClass (using a . instead of a :)
  • verify that the image has certain runtime properties (e.g. pctasks.* installed). https://github.com/NVIDIA/container-canary might be a nice tool to use here.

(feel free to add more requests here)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the workflow submission or validation entry point and reviewing how workflow task and image fields are represented. Use the two checklist items to define the initial linter scope: validate the task reference format and check required runtime properties in the image. Done means both checks report actionable errors before submission.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.