[RHELC-1748] Manpage generation check #1422

Andrew-ang9 · 2024-11-04T19:42:40Z

This PR sets up the GitHub action so that going forward we will be able to know if we need to generate the manpages per PR basis so that we can always have the manpages up to date.

Jira Issues:

-RHELC-1748

Checklist

PR has been tested manually in a VM (either author or reviewer)
Jira issue has been made public if possible
[RHELC-] or [HMS-] is part of the PR title
Label depicting the kind of PR it is
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 · 2024-11-04T19:45:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@5be973f). Learn more about missing BASE report.
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1422   +/-   ##
=======================================
  Coverage        ?   96.11%           
=======================================
  Files           ?       72           
  Lines           ?     5178           
  Branches        ?      896           
=======================================
  Hits            ?     4977           
  Misses          ?      119           
  Partials        ?       82

Flag	Coverage Δ
centos-linux-7	`91.63% <100.00%> (?)`
centos-linux-8	`92.49% <100.00%> (?)`
centos-linux-9	`92.61% <100.00%> (?)`

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.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

Venefilyn

In short, I would want to see

Manpages are generated and checked to see if there are changes
Manpages are checked for each commit on main and commit in a PR
Manpages workflow fails if there is a difference and passes if there are no changes

Venefilyn · 2024-11-08T09:35:53Z

.github/workflows/build-rpm.yml

+      - name: Trigger Manpage Generation
+        run: |
+          oamg/convert2rhel/.github/workflows/generate_manpage.yml@main
+


To get this to work generate_manpage.yml needs to be a runnable workflow. But don't think it's necessary to run it here tbh, we can keep to just running it on every PR

Venefilyn · 2024-11-08T09:38:22Z

scripts/manpage_generation.sh

It's not enough to check with the previous version. I would like to see the manpages generated and the difference checked to see if there are any changes. Not just if the version changed.

As this will fail every time we submit a new version it's already too late to update too.

Venefilyn · 2024-11-12T12:03:37Z

scripts/manpage_generation.sh


 # Generate the manpage using argparse-manpage
-PYTHONPATH=. /usr/bin/python /home/runner/.local/bin/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 $CURRENT_VER" --prog="convert2rhel" --include man/distribution --include man/synopsis > "$MANPAGE_DIR/convert2rhel.8"


We're missing python call here. Does it still work locally?

Venefilyn · 2024-11-12T12:03:44Z

scripts/manpage_generation.sh

+if ! git diff --quiet HEAD -- "$MANPAGE_DIR/convert2rhel.8"; then
+    echo "Manpages are outdated. Please update them."
+    exit 1
+else
+    echo "Manpages are up-to-date."
+    exit 0
+fi


Venefilyn · 2024-11-12T12:04:47Z

scripts/manpage_generation.sh

+# Ensure the manpage directory exists
+mkdir -p "$MANPAGE_DIR"


* Added in the the check to see if the manpages should be generated or not * Changed the generate_manpage.yml file so that it sets up the action as needed, and removed some of the things not needed

* The main thing we should check here is to make sure the manpages needed to be updated so we don't need to see the version as it would be too late and we want this to happen on all PRs

* on the last commit some of the set up for the action was removed and now it is back * added in the manpage generation command back to the manpage_generation.sh script

* How cli.py was calling the atributes from rpm for the pre and post RPM_VA_LOG_FILENAME was causing an error whenever I tried to run the GitHub action and the manpage command locally so to fix it I imported the the vars directly into cli.py

* reveted back a bit because the action is failing with some old errors that were already fixed

Venefilyn · 2024-11-28T12:18:57Z

Containerfiles/manpage_check.Containerfile

I noticed the workflow is not using a container or the script. But if this container works locally it's just a matter of running it in the GitHub workflow

Since we don't need the results exported in any way, but rather to exit the container with a code if there is a change

I talked about this PR with Mb, and they suggested that if everything could just be done in the action, that could fix some of the issues that I was having. The action works as it should. The error shown now is a separate issue from this PR, but you can see that at the end of it, it does show the correct message for the manpages, as currently, in this PR, there are changes in the manpages file.

Andrew-ang9 requested review from Venefilyn and bocekm as code owners November 4, 2024 19:45

Andrew-ang9 force-pushed the auto-gen-manpages-final branch from a88ffb5 to d7b5428 Compare November 4, 2024 20:23

Venefilyn requested changes Nov 8, 2024

View reviewed changes

Venefilyn reviewed Nov 12, 2024

View reviewed changes

Andrew-ang9 marked this pull request as draft November 12, 2024 19:27

Andrew-ang9 force-pushed the auto-gen-manpages-final branch 3 times, most recently from ac655b7 to 9c0900b Compare November 19, 2024 18:54

Andrew-ang9 marked this pull request as ready for review November 19, 2024 19:12

Andrew-ang9 requested a review from a team as a code owner November 21, 2024 01:45

Andrew-ang9 added 18 commits November 27, 2024 09:10

Added in the check for the version for the manpage

fdb6c3f

* Added in the the check to see if the manpages should be generated or not * Changed the generate_manpage.yml file so that it sets up the action as needed, and removed some of the things not needed

Added in a check to see if the manpages

8605004

removed the check for the version

2cf6892

* The main thing we should check here is to make sure the manpages needed to be updated so we don't need to see the version as it would be too late and we want this to happen on all PRs

Fixed the action

d750568

* on the last commit some of the set up for the action was removed and now it is back * added in the manpage generation command back to the manpage_generation.sh script

Added rpm to the other dependencies being installed

fe28782

edited the command for generating the manpages

674ad99

added in the config files in the action

c0c1754

added in the installation of rpm to the action

1400d37

used the rpm-py-install to get rpm

148906c

change to using spt-get for rpm

f30d20e

draft looking to see if rpm and python-rpm are installed

6ea158e

added the use of a podman container

1350c41

added the right name for the container file

52e85d0

fixed the containerfiles dir spelling in the action

b8dbd5b

draft specfied the container file path

39e6fd7

draft added in a virtual enviorment to the container

2c92f8a

draft set the path for the manpage_generation.sh file

424f1de

Andrew-ang9 added 13 commits November 27, 2024 09:11

added in a check to see if pexpect is in the action

632ee69

added in the verification for rpm

7dbc24d

added universe repo as it has the packages

e5325da

changed to use python3-rpm

859773d

added a manuel install of rpm and python bindings

d6fb1a7

added in the install NSPR and NSS development

419689d

seperated commands to make sure they run properly

3efe1d6

added in the installation of libnpipt-dev

045404a

added in libarchive-dev to get the rest of the packages

184b95f

added in libdb-dev for db.h

5c8ace0

set an updated version of python for 3.10

f702d2e

added in setting the env vars per the action

cd67883

added to the installations a way to disable lua

874e81a

Andrew-ang9 force-pushed the auto-gen-manpages-final branch from aa5bcf3 to 874e81a Compare November 27, 2024 14:11

Andrew-ang9 added 13 commits November 27, 2024 09:25

drafr added the download for all the depencies for rpm

37af56b

added in the install for six

b07b946

removed an extra "()" on line 138

92a478d

fixed the path for cli in the action

084e04c

fix the import for cli

c1fac74

fixed the use of the class for cli

5dd979a

reveted the recent change for the cli path

0794325

added some debug messages to fix the issue

22b6c57

added in six

15052d9

reverted back to old commit

82a8924

added in some debug statments

b5f7d7a

added the install for six

3a26cb0

reverted back a bit

e88f0dc

* reveted back a bit because the action is failing with some old errors that were already fixed

Venefilyn reviewed Nov 28, 2024

View reviewed changes

Andrew-ang9 added 2 commits December 3, 2024 11:36

makes a balnk convert2rhel.ini file

33bd3a9

added placeholder stuff in the convert2rhel.ini

a63333b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RHELC-1748] Manpage generation check #1422

[RHELC-1748] Manpage generation check #1422

Andrew-ang9 commented Nov 4, 2024 •

edited

Loading

codecov bot commented Nov 4, 2024 •

edited

Loading

Venefilyn left a comment

Venefilyn Nov 8, 2024

Venefilyn Nov 8, 2024

Venefilyn Nov 12, 2024

Venefilyn Nov 12, 2024

Venefilyn Nov 12, 2024

Venefilyn Nov 28, 2024 •

edited

Loading

Andrew-ang9 Dec 3, 2024

		# Ensure the manpage directory exists
		mkdir -p "$MANPAGE_DIR"

[RHELC-1748] Manpage generation check #1422

Are you sure you want to change the base?

[RHELC-1748] Manpage generation check #1422

Conversation

Andrew-ang9 commented Nov 4, 2024 • edited Loading

codecov bot commented Nov 4, 2024 • edited Loading

Codecov Report

Venefilyn left a comment

Choose a reason for hiding this comment

Venefilyn Nov 8, 2024

Choose a reason for hiding this comment

Venefilyn Nov 8, 2024

Choose a reason for hiding this comment

Venefilyn Nov 12, 2024

Choose a reason for hiding this comment

Venefilyn Nov 12, 2024

Choose a reason for hiding this comment

Venefilyn Nov 12, 2024

Choose a reason for hiding this comment

Venefilyn Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

Andrew-ang9 Dec 3, 2024

Choose a reason for hiding this comment

Andrew-ang9 commented Nov 4, 2024 •

edited

Loading

codecov bot commented Nov 4, 2024 •

edited

Loading

Venefilyn Nov 28, 2024 •

edited

Loading