Koenkk / Koenkk/zigbee2mqtt-chart

Add make docs in CI and check no diffs

Open
#39 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
37
Forks
24
Avg merge
2d 22h
Merged PRs (30d)
2

Description

We need to generate the helm docs in CI and fail the build if it has generated changes.

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 repository's CI configuration and the make docs entry point named in the issue. Run the documentation generation command, then verify that CI detects generated changes; done means the build fails when Helm docs are out of date and passes when no diff is produced.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.