Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions .github/workflows/jenkins-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,15 @@ on:
- created
pull_request_target:
types: [opened, synchronize, reopened]
paths-ignore:
- 'cicd*.groovy'
- '**/LICENSE'
- 'docs/**'
- 'README.md'
paths:
# Files and folders copied by metaport's buildenv (zopen_install)
- 'bin/**'
- 'include/**'
- 'data/**'
- 'patch-utils/**'
- '.env'
- 'cacert.pem'
- 'LICENSE'
workflow_dispatch:

jobs:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ docs/.vitepress/cache/
docs/updatestatus.md
docs/upstreamstatus.md
docs/images/upstream/
docs/images/progress.png
docs/images/quality.png
docs/images/quality_part_*.png
docs/Latest.md
docs/Progress.md
docs/Vulnerabilities.md
Expand Down
37 changes: 24 additions & 13 deletions cicd/generate_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
#
# Script to generate all documentation pages and assets required by VitePress.
# Output:
# - docs/api/python_packages.json (from the api-cache release)
# - docs/api/rpm_packages.json (from the api-cache release)
# - docs/api/*.json (downloaded from the api-cache release)
# - docs/updatestatus.md
# - docs/upstreamstatus.md and docs/images/upstream/*
# - docs/Latest.md and docs/Progress.md
Expand All @@ -30,21 +29,33 @@ echo "=== Generating VitePress Documentation Pages ==="
mkdir -p docs/reference
mkdir -p docs/images/upstream

# VitePress embeds this catalog at build time. Port-Update-Release publishes
# fresh data to api-cache without updating the snapshot committed in Git.
# Fail if the download fails so a deployment cannot silently use stale data.
echo "Downloading the published Python package catalog..."
# The docs/api/*.json files are generated and published to the api-cache release
# by the Port-Update-Release and nightly jobs; they are not committed in Git.
# Fail if a required download fails so a deployment cannot silently use stale data.
API_CACHE_URL="https://github.com/zopencommunity/meta/releases/download/api-cache"
mkdir -p docs/api
curl --fail --location --silent --show-error \
--retry 3 --connect-timeout 10 --max-time 120 \
--output docs/api/python_packages.json \
https://github.com/zopencommunity/meta/releases/download/api-cache/python_packages.json

echo "Downloading the published RPM package catalog..."
for file in \
python_packages.json \
rpm_packages.json \
zopen_files.json \
zopen_releases.json \
zopen_releases_latest.json \
zopen_releases_descriptions.json; do
echo "Downloading the published ${file}..."
curl --fail --location --silent --show-error \
--retry 3 --connect-timeout 10 --max-time 120 \
--output "docs/api/${file}" \
"${API_CACHE_URL}/${file}"
done

# Only uploaded when available; the consuming tools fall back to the remote URL.
echo "Downloading the published zopen_vulnerability.json (optional)..."
curl --fail --location --silent --show-error \
--retry 3 --connect-timeout 10 --max-time 120 \
--output docs/api/rpm_packages.json \
https://github.com/zopencommunity/meta/releases/download/api-cache/rpm_packages.json
--output docs/api/zopen_vulnerability.json \
"${API_CACHE_URL}/zopen_vulnerability.json" \
|| echo "Warning: zopen_vulnerability.json not available; continuing."

# 1. Generate the currency status (docs/updatestatus.md)
echo "Generating currency status..."
Expand Down
Binary file removed docs/images/progress.png
Binary file not shown.
Binary file removed docs/images/quality.png
Binary file not shown.
Binary file removed docs/images/quality_part_1.png
Binary file not shown.
Binary file removed docs/images/quality_part_2.png
Binary file not shown.
Binary file removed docs/images/quality_part_3.png
Binary file not shown.
Binary file removed docs/images/quality_part_4.png
Binary file not shown.
3,492 changes: 0 additions & 3,492 deletions docs/newly_released.md

This file was deleted.

Empty file removed man/man1/zopen.1
Empty file.
Loading