Skip to content

ci: Fix html files not being built - #455

Closed
lucasdemarchi wants to merge 4 commits into
masterfrom
tip-fix-docs
Closed

ci: Fix html files not being built#455
lucasdemarchi wants to merge 4 commits into
masterfrom
tip-fix-docs

Conversation

@lucasdemarchi

Copy link
Copy Markdown
Contributor

Also (hopefully) allow to generate docs for past releases.

@evelikov evelikov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A while ago, I was thinking of a slightly different approach:

  • trigger on tag push
  • iterate all tags, generate the docs for each - older versions might need different build command
  • for each missing -> push to staging
  • for each re-generated -> flag the diff, allow to continue manually (gitlab has manual job triggers, don't recall if GH does) or via special env. variable
  • once staging is full -> release

Comment thread .github/workflows/docs.yml
Comment thread .github/workflows/docs.yml
Comment thread .github/workflows/docs.yml
Comment thread .github/workflows/docs.yml
@evelikov

evelikov commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

I am loving the docs alias, but not sure if we can use it (or meson in general) to push docs for pre-meson kmod tags/versions.

@lucasdemarchi

Copy link
Copy Markdown
Contributor Author

I am loving the docs alias, but not sure if we can use it (or meson in general) to push docs for pre-meson kmod tags/versions.

right... but I started this only to generate v34, not anything older than that. We can go back and do that, but then maybe we don't need it this github workflow...

libkmod-3-docs is too long and hard to remember. Add an alias.

Signed-off-by: Lucas De Marchi <demarchi@kernel.org>
The html docs is not build by default. Also, there's no need to build
anything else: the custom target for docs can be executed directly.
Finally, move to the newly-introduced 'docs' alias.

Signed-off-by: Lucas De Marchi <demarchi@kernel.org>
Add a workflow_dispatch that accepts the tag as input. This should allow
docs to be generated for a past release and populate the
https://kmod-project.github.io/ website.

Signed-off-by: Lucas De Marchi <demarchi@kernel.org>
Allow to build all man pages without depending on the rest of the build.

Signed-off-by: Lucas De Marchi <demarchi@kernel.org>

@evelikov evelikov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't have the means to quickly test and overall it looks good.

lucasdemarchi added a commit that referenced this pull request Aug 10, 2026
libkmod-3-docs is too long and hard to remember. Add an alias.

Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: #455
Signed-off-by: Lucas De Marchi <demarchi@kernel.org>
lucasdemarchi added a commit that referenced this pull request Aug 10, 2026
The html docs is not build by default. Also, there's no need to build
anything else: the custom target for docs can be executed directly.
Finally, move to the newly-introduced 'docs' alias.

Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: #455
Signed-off-by: Lucas De Marchi <demarchi@kernel.org>
lucasdemarchi added a commit that referenced this pull request Aug 10, 2026
Add a workflow_dispatch that accepts the tag as input. This should allow
docs to be generated for a past release and populate the
https://kmod-project.github.io/ website.

Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: #455
Signed-off-by: Lucas De Marchi <demarchi@kernel.org>
lucasdemarchi added a commit that referenced this pull request Aug 10, 2026
Allow to build all man pages without depending on the rest of the build.

Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: #455
Signed-off-by: Lucas De Marchi <demarchi@kernel.org>
@lucasdemarchi

Copy link
Copy Markdown
Contributor Author

Applied, thanks

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.

2 participants