[RHELC-1037] Auto-generate manpages #876

Andrew-ang9 · 2023-08-04T22:12:28Z

Convert2RHEL has moved away from using optparse, and we have decided to use argparse to generate our manpages now; this PR will change this by adding in a bash script to generate the manpages using argparse, and then it will be automated using GitHub actions.

Jira Issues: RHELC-1037

Checklist

PR has been tested manually in a VM (either author or reviewer)
Jira issue has been made public if possible
[RHELC-] is part of the PR title
GitHub label has been added to help with Release notes
PR title explains the change from the user's point of view
Code and tests are documented properly
The commits are squashed to as few commits as possible (without losing data)
When merged: Jira issue has been updated to Release Pending if relevant

codecov · 2023-08-04T22:14:23Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (6476ef8) 94.07% compared to head (9ec4038) 94.07%.
Report is 31 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #876   +/-   ##
=======================================
  Coverage   94.07%   94.07%           
=======================================
  Files          40       40           
  Lines        3864     3864           
  Branches      695      695           
=======================================
  Hits         3635     3635           
  Misses        162      162           
  Partials       67       67

Flag	Coverage Δ
centos-linux-7	`89.10% <ø> (ø)`
centos-linux-8	`89.72% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

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

r0x0d · 2023-08-08T14:58:55Z

@Andrew-ang9, I believe you can use this https://github.com/praiskup/argparse-manpage to generate the manpages right now, this is what we used for the last release to generate the manpage, so, I think that using this project in your automation will be a good choice

has-bot · 2023-08-21T14:16:49Z

/packit test --labels tier0

@oamg/conversions-qe please review results and provide ack.

Log | Bot Usage

.github/workflows/generate_manpages.yml

scripts/manpage_generation.sh

.github/workflows/release.yml

scripts/manpage_generation.sh

.github/workflows/generate_manpages.yml

scripts/manpage_generation.sh

.github/workflows/release.yml

r0x0d

Made a few comments to improve the PR.

Also, it would be good if you can test this workflow in your own fork,. creating tags/releases and seeing if this is being executed properly.

scripts/manpage_generation.sh

Venefilyn · 2023-09-19T16:59:07Z

Approved, lets merge and see how it looks when we run it in main

@bocekm please approve

.github/workflows/generate_manpages.yml

.github/workflows/release.yml

scripts/manpage_generation.sh

* We are moving away from optparse and we are moving to argparse. So with that chaange we have to alter how we generate manpages. We now use git actions and a bash script to generate the manpages and add that to the release workflow

Venefilyn · 2023-09-20T16:03:42Z

scripts/manpage_generation.sh

+python -c 'from convert2rhel import toolopts; print("[synopsis]\n."+toolopts.CLI.usage())' > man/synopsis
+
+# Generate the manpage using argparse-manpage
+PYTHONPATH=. argparse-manpage --pyfile man/__init__.py --function get_parser --manual-title="General Commands Manual" --description="Automates the conversion of Red Hat Enterprise Linux derivative distributions to Red Hat Enterprise Linux." --project-name "convert2rhle $Ver" --prog="convert2rhel" --include man/distribution --include man/synopsis > "$MANPAGE_DIR/convert2rhel.8"


Suggested change

PYTHONPATH=. argparse-manpage --pyfile man/__init__.py --function get_parser --manual-title="General Commands Manual" --description="Automates the conversion of Red Hat Enterprise Linux derivative distributions to Red Hat Enterprise Linux." --project-name "convert2rhle $Ver" --prog="convert2rhel" --include man/distribution --include man/synopsis > "$MANPAGE_DIR/convert2rhel.8"

PYTHONPATH=. argparse-manpage --pyfile man/__init__.py --function get_parser --manual-title="General Commands Manual" --description="Automates the conversion of Red Hat Enterprise Linux derivative distributions to Red Hat Enterprise Linux." --project-name "convert2rhel $VER" --prog="convert2rhel" --include man/distribution --include man/synopsis > "$MANPAGE_DIR/convert2rhel.8"

I have fixed this error!

Venefilyn · 2023-09-20T17:24:06Z

scripts/manpage_generation.sh

+python -c 'from convert2rhel import toolopts; print("[synopsis]\n."+toolopts.CLI.usage())' > man/synopsis
+
+# Generate the manpage using argparse-manpage
+PYTHONPATH=. argparse-manpage --pyfile man/__init__.py --function get_parser --manual-title="General Commands Manual" --description="Automates the conversion of Red Hat Enterprise Linux derivative distributions to Red Hat Enterprise Linux." --project-name "convert2rhel $Ver" --prog="convert2rhel" --include man/distribution --include man/synopsis > "$MANPAGE_DIR/convert2rhel.8"


Issue is still here, we need $VER not $Ver, otherwise it isn't the same as on line 6

Suggested change

PYTHONPATH=. argparse-manpage --pyfile man/__init__.py --function get_parser --manual-title="General Commands Manual" --description="Automates the conversion of Red Hat Enterprise Linux derivative distributions to Red Hat Enterprise Linux." --project-name "convert2rhel $Ver" --prog="convert2rhel" --include man/distribution --include man/synopsis > "$MANPAGE_DIR/convert2rhel.8"

PYTHONPATH=. argparse-manpage --pyfile man/__init__.py --function get_parser --manual-title="General Commands Manual" --description="Automates the conversion of Red Hat Enterprise Linux derivative distributions to Red Hat Enterprise Linux." --project-name "convert2rhel $VER" --prog="convert2rhel" --include man/distribution --include man/synopsis > "$MANPAGE_DIR/convert2rhel.8"

whoops my apologies will fix now!

@SpyTec fixed and pushed

Andrew-ang9 added kind/documentation Improvements or additions to documentation kind/feature New feature or request labels Aug 14, 2023

Venefilyn changed the title ~~[RHEL-C1037] (Draft) Auto generate manpage~~ [RHELC-1037] (Draft) Auto generate manpage Aug 14, 2023

Andrew-ang9 added the tests/tier0 PR ready to run the essential test suit. Equivalent to `/packit test --labels tier0`. label Aug 21, 2023

mfocko mentioned this pull request Aug 22, 2023

Fails with labels in TF comment trigger, but without labels in config packit/packit-service#2155

Closed

Venefilyn reviewed Aug 23, 2023

View reviewed changes

.github/workflows/generate_manpages.yml Outdated Show resolved Hide resolved

r0x0d reviewed Aug 23, 2023

View reviewed changes

scripts/manpage_generation.sh Outdated Show resolved Hide resolved

Venefilyn requested changes Aug 25, 2023

View reviewed changes

scripts/manpage_generation.sh Outdated Show resolved Hide resolved

.github/workflows/release.yml Outdated Show resolved Hide resolved

r0x0d reviewed Aug 29, 2023

View reviewed changes

scripts/manpage_generation.sh Outdated Show resolved Hide resolved

r0x0d reviewed Aug 29, 2023

View reviewed changes

scripts/manpage_generation.sh Outdated Show resolved Hide resolved

r0x0d reviewed Aug 29, 2023

View reviewed changes

.github/workflows/generate_manpages.yml Outdated Show resolved Hide resolved

r0x0d reviewed Sep 13, 2023

View reviewed changes

.github/workflows/generate_manpages.yml Outdated Show resolved Hide resolved

r0x0d reviewed Sep 13, 2023

View reviewed changes

scripts/manpage_generation.sh Outdated Show resolved Hide resolved

r0x0d reviewed Sep 13, 2023

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

r0x0d reviewed Sep 13, 2023

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

r0x0d reviewed Sep 13, 2023

View reviewed changes

r0x0d reviewed Sep 15, 2023

View reviewed changes

scripts/manpage_generation.sh Outdated Show resolved Hide resolved

Venefilyn changed the title ~~[RHELC-1037] (Draft) Auto generate manpage~~ [RHELC-1037] Auto-generate manpage Sep 18, 2023

Venefilyn changed the title ~~[RHELC-1037] Auto-generate manpage~~ [RHELC-1037] Auto-generate manpages Sep 18, 2023

bocekm requested changes Sep 19, 2023

View reviewed changes

scripts/manpage_generation.sh Outdated Show resolved Hide resolved

Venefilyn approved these changes Sep 19, 2023

View reviewed changes

Venefilyn requested a review from bocekm September 19, 2023 16:58

bocekm requested changes Sep 19, 2023

View reviewed changes

.github/workflows/generate_manpages.yml Outdated Show resolved Hide resolved

.github/workflows/release.yml Outdated Show resolved Hide resolved

scripts/manpage_generation.sh Outdated Show resolved Hide resolved

Auto-gen manpages

7de27df

* We are moving away from optparse and we are moving to argparse. So with that chaange we have to alter how we generate manpages. We now use git actions and a bash script to generate the manpages and add that to the release workflow

Andrew-ang9 force-pushed the auto_gen_manpage branch from 1f82472 to 7de27df Compare September 20, 2023 14:18

fixed the spelling on the bash script

44c0716

Added in a command to add the synopsis

d1497b6

bocekm approved these changes Sep 20, 2023

View reviewed changes

Venefilyn reviewed Sep 20, 2023

View reviewed changes

fixed a typo in genreate manpage command

c160dc2

Venefilyn requested changes Sep 20, 2023

View reviewed changes

fixed a typo

9ec4038

Venefilyn approved these changes Sep 20, 2023

View reviewed changes

Venefilyn merged commit 8ef55c6 into oamg:main Sep 20, 2023
12 of 16 checks passed

hosekadam pushed a commit to hosekadam/convert2rhel that referenced this pull request Oct 2, 2023

[RHELC-1037] Auto-generate manpages (oamg#876)

d968798

Andrew-ang9 added a commit to Andrew-ang9/convert2rhel that referenced this pull request Oct 10, 2023

[RHELC-1037] Auto-generate manpages (oamg#876)

5cfb332

bocekm mentioned this pull request Oct 30, 2023

Bump to version 1.5.0 #976

Merged

Venefilyn mentioned this pull request Dec 11, 2023

[RHELC-1037] Add manpage generation to all releases #1011

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RHELC-1037] Auto-generate manpages #876

[RHELC-1037] Auto-generate manpages #876

Andrew-ang9 commented Aug 4, 2023 •

edited

Loading

codecov bot commented Aug 4, 2023 •

edited

Loading

r0x0d commented Aug 8, 2023

has-bot commented Aug 21, 2023

r0x0d left a comment

Venefilyn commented Sep 19, 2023

Venefilyn Sep 20, 2023

Andrew-ang9 Sep 20, 2023

Venefilyn Sep 20, 2023

Andrew-ang9 Sep 20, 2023

Andrew-ang9 Sep 20, 2023

	PYTHONPATH=. argparse-manpage --pyfile man/__init__.py --function get_parser --manual-title="General Commands Manual" --description="Automates the conversion of Red Hat Enterprise Linux derivative distributions to Red Hat Enterprise Linux." --project-name "convert2rhle $Ver" --prog="convert2rhel" --include man/distribution --include man/synopsis > "$MANPAGE_DIR/convert2rhel.8"
	PYTHONPATH=. argparse-manpage --pyfile man/__init__.py --function get_parser --manual-title="General Commands Manual" --description="Automates the conversion of Red Hat Enterprise Linux derivative distributions to Red Hat Enterprise Linux." --project-name "convert2rhel $VER" --prog="convert2rhel" --include man/distribution --include man/synopsis > "$MANPAGE_DIR/convert2rhel.8"

[RHELC-1037] Auto-generate manpages #876

[RHELC-1037] Auto-generate manpages #876

Conversation

Andrew-ang9 commented Aug 4, 2023 • edited Loading

codecov bot commented Aug 4, 2023 • edited Loading

Codecov Report

r0x0d commented Aug 8, 2023

has-bot commented Aug 21, 2023

r0x0d left a comment

Choose a reason for hiding this comment

Venefilyn commented Sep 19, 2023

Venefilyn Sep 20, 2023

Choose a reason for hiding this comment

Andrew-ang9 Sep 20, 2023

Choose a reason for hiding this comment

Venefilyn Sep 20, 2023

Choose a reason for hiding this comment

Andrew-ang9 Sep 20, 2023

Choose a reason for hiding this comment

Andrew-ang9 Sep 20, 2023

Choose a reason for hiding this comment

Andrew-ang9 commented Aug 4, 2023 •

edited

Loading

codecov bot commented Aug 4, 2023 •

edited

Loading