Skip to content

chore: stop tracking generated documentation - #55

Merged
Taure merged 1 commit into
mainfrom
fix/untrack-generated-docs
Aug 6, 2026
Merged

chore: stop tracking generated documentation#55
Taure merged 1 commit into
mainfrom
fix/untrack-generated-docs

Conversation

@Taure

@Taure Taure commented Aug 6, 2026

Copy link
Copy Markdown
Owner

doc/ is ex_doc output. It got committed by three recent PRs of mine (#52, #53, #54) that staged everything, and it should not have been - the directory did not exist before them.

It is build output, not source:

  • nothing in it is reviewable
  • a version bump rewrites every file, so the last two dependency bumps each carried ~1000 lines of noise that said only v1.9.5 -> v1.9.6
  • it goes stale the moment a tag moves, so the committed copy currently disagrees with what is published

minato, kura and kura_postgres all have doc/ in .gitignore and track zero files there. shigoto was the odd one out only because it lacked the line.

Removes the 56 tracked files and adds the ignore entry. rebar3 ex_doc still generates them locally, and rebar3 hex publish still uploads the docs tarball - neither depends on them being in git.

ex_doc writes doc/, and three recent commits swept it into the repository
because they staged everything. It is build output: it has no reviewable
content, and a version bump rewrites every file, which was a thousand lines
of noise in the last two dependency bumps.

minato, kura and kura_postgres all ignore it. shigoto now does too.
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

🟠 Code Coverage — 57.4%

1015 of 1769 lines covered.


🟡 ELP Lint — 1 warning

1 diagnostic found. See job logs for details.

@Taure
Taure merged commit 93d3c23 into main Aug 6, 2026
17 checks passed
@Taure
Taure deleted the fix/untrack-generated-docs branch August 6, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant