Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci(docs): generate documentation from policy definition #849

Merged
merged 8 commits into from
Nov 16, 2023

Conversation

didrocks
Copy link
Member

Generate within CI the whole documentation for supported policies


UDENG-1450

@didrocks didrocks force-pushed the documentation_for_policies_ci branch from efc8feb to 074258b Compare November 15, 2023 15:12
@didrocks
Copy link
Member Author

waiting for the other documentation related PRs to be merged first before rebasing so that tests pass.

@didrocks didrocks force-pushed the documentation_for_policies_ci branch from 074258b to 832ebd3 Compare November 16, 2023 09:12
@codecov-commenter
Copy link

codecov-commenter commented Nov 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (cabdeca) 85.98% compared to head (41bf791) 86.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #849      +/-   ##
==========================================
+ Coverage   85.98%   86.00%   +0.02%     
==========================================
  Files          76       76              
  Lines        8718     8718              
==========================================
+ Hits         7496     7498       +2     
+ Misses        884      883       -1     
+ Partials      338      337       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

didrocks and others added 4 commits November 16, 2023 10:23
As this is going to do more than just admx and adml generation, but docs
too.
This will be used when generating the documentation later on, as
container directories.
Hook up in parallel to adm* generation, documentation generations under
docs/
@didrocks didrocks force-pushed the documentation_for_policies_ci branch from 8a1353e to 60d9097 Compare November 16, 2023 09:23
didrocks and others added 4 commits November 16, 2023 11:01
Some are coming from dconf keys, which we can’t patch out in the
documentation. Most of them are comprehensible, so let’s ignore them.
@didrocks didrocks marked this pull request as ready for review November 16, 2023 10:18
@didrocks didrocks requested a review from a team as a code owner November 16, 2023 10:18
@didrocks
Copy link
Member Author

@jibel: And the final piece, the icing on the cake!
Note that only 006322f, 2cbc0e5 and fb34abe are the actual commits, the generated PR with the content has been triggered as PR #851 and was merged in after checking.

@didrocks didrocks requested a review from jibel November 16, 2023 10:19
Copy link
Collaborator

@jibel jibel left a comment

Choose a reason for hiding this comment

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

Good YAML programming skills :)

Copy link
Collaborator

@jibel jibel left a comment

Choose a reason for hiding this comment

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

Trivial. Thanks!

@didrocks didrocks merged commit 7a7cba5 into main Nov 16, 2023
6 checks passed
@didrocks didrocks deleted the documentation_for_policies_ci branch November 16, 2023 12:31
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.

3 participants