NixOS / NixOS/hydra

Document Hydra declarative input types

Open
#970 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PLpgSQL
Stars
1.6k
Forks
358
Avg merge
20h 30m
Merged PRs (30d)
27

Description

I can see that Hydra offers an API for remotely creating projects and jobsets with declarative inputs.

The catch: Nowhere could I find proper documentation for the many input types listed in the dropdown available from the web interface, apart from string and git.

Overall, I find the aspect of declarative jobsets to be poorly documented on Hydra.

Contributor guide

Open the contributing guide

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

The issue points to the web interface's input-type dropdown and declarative jobsets, but it names no files, tests, or documentation entry point. Start by locating the existing API and web-interface documentation for declarative jobsets, then identify every listed input type and document its purpose and usage. Done means the input types shown in the dropdown are covered beyond string and git.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.