[RHELC-1748] Manpage generation check #1422
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,103 @@ | ||
| name: Update Manpages | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| pull_request: | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
| update-manpages: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: '3.10' | ||
|
|
||
| - name: Add Universe Repository | ||
| run: | | ||
| sudo add-apt-repository universe | ||
| sudo apt-get update | ||
|
|
||
| - name: Install dependencies | ||
| run: | | ||
| sudo apt-get install -y python3-pip rpm libnspr4-dev libnss3-dev libpopt-dev libarchive-dev libdb-dev \ | ||
| autoconf automake bison flex gettext libtool pkg-config | ||
| pip install --upgrade pip | ||
| pip install pexpect argparse-manpage six | ||
|
|
||
| - name: Create /etc/convert2rhel.ini | ||
| run: | | ||
| sudo mkdir -p /etc | ||
| sudo bash -c 'cat <<EOF > /etc/convert2rhel.ini | ||
| [main] | ||
| subscription_manager = placeholder_value | ||
| host_metering = placeholder_value | ||
| inhibitor_overrides = placeholder_value | ||
| EOF' | ||
|
|
||
| - name: Download and install RPM | ||
| run: | | ||
| wget http://ftp.rpm.org/releases/rpm-4.14.x/rpm-4.14.2.tar.bz2 | ||
| tar -xjf rpm-4.14.2.tar.bz2 | ||
| cd rpm-4.14.2 | ||
| export PKG_CONFIG_PATH=/opt/hostedtoolcache/Python/3.10.15/x64/lib/pkgconfig | ||
| export PYTHON_CFLAGS="-I/opt/hostedtoolcache/Python/3.10.15/x64/include/python3.10" | ||
| export PYTHON_LIBS="-L/opt/hostedtoolcache/Python/3.10.15/x64/lib -lpython3.10" | ||
| ./configure --disable-nls --enable-python --without-lua | ||
| make | ||
| sudo make install | ||
| cd python | ||
| python3 setup.py install | ||
| sudo ldconfig | ||
|
|
||
| - name: Verify Python Path | ||
| run: | | ||
| python -c "import sys; print(sys.path)" | ||
| python -c "import pexpect; print('pexpect module is available.')" | ||
| python -c "import rpm; print('rpm module is available.')" | ||
|
|
||
| - name: Debug CLI Attribute | ||
| run: | | ||
| python -c "import convert2rhel.cli as cli; print(dir(cli)); print(cli.CLI)" || exit 1 | ||
|
|
||
| - name: Generate manpages | ||
| run: | | ||
| set -e | ||
|
|
||
| # Directory to store the generated manpages | ||
| MANPAGE_DIR='man' | ||
|
|
||
| # Ensure the manpage directory exists | ||
| mkdir -p "$MANPAGE_DIR" | ||
|
|
||
| echo 'Generating manpages' | ||
|
|
||
| # Add debug statements | ||
| python -c 'import convert2rhel.cli as cli; print(dir(cli)); print(cli.CLI)' || exit 1 | ||
|
|
||
| # Generate a file with convert2rhel synopsis for argparse-manpage | ||
| python -c 'from convert2rhel.cli import CLI; print("[synopsis]\n."+CLI.usage())' > "$MANPAGE_DIR/synopsis" | ||
|
|
||
| # Extract the current version from the spec file | ||
| CURRENT_VER=$(grep -oP '^Version:\s+\K\S+' packaging/convert2rhel.spec) | ||
| echo 'Current version: $CURRENT_VER' | ||
|
|
||
| # 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 $CURRENT_VER' --prog='convert2rhel' --include man/distribution --include man/synopsis > "$MANPAGE_DIR/convert2rhel.8" | ||
|
|
||
| # Check for differences in the generated manpage | ||
| 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Use the latest Fedora image as the base | ||
| FROM quay.io/fedora/fedora:latest | ||
|
|
||
| # Install system dependencies | ||
| RUN dnf install -y \ | ||
| python3 \ | ||
| python3-pip \ | ||
| python3-devel \ | ||
| rpm-devel \ | ||
| python3-rpm \ | ||
| git \ | ||
| && dnf clean all | ||
|
|
||
| # Install Python packages | ||
| RUN pip3 install --upgrade pip | ||
| RUN pip3 install pexpect argparse-manpage six | ||
|
|
||
| # Set the working directory | ||
| WORKDIR /app | ||
|
|
||
| # Copy the project files into the container | ||
| COPY . /app | ||
|
|
||
| # Copy the convert2rhel.ini configuration file into the container | ||
| COPY config/convert2rhel.ini /etc/convert2rhel/convert2rhel.ini | ||
|
|
||
| # Copy manpage_generation.sh from the scripts directory into the container | ||
| COPY scripts/manpage_generation.sh /app/ | ||
|
|
||
| # Ensure the script is executable | ||
| RUN chmod +x /app/manpage_generation.sh | ||
|
|
||
| # Set up entrypoint to run manpage_generation.sh | ||
| ENTRYPOINT ["/app/manpage_generation.sh"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.