Skip to content

fix(docs): include markdown and XML in package archives #150

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 12, 2025
Merged

fix(docs): include markdown and XML in package archives #150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 15 additions & 7 deletions tasks/docs/package.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,33 @@ if [ ! -f "${DOCS_DIR}/html/index.html" ]; then
exit 1
fi

# Validate documentation directory has content
if [ ! -d "${DOCS_DIR}/html" ] || [ -z "$(ls -A ${DOCS_DIR}/html)" ]; then
echo "Error: ${DOCS_DIR}/html is empty or does not exist"
if [ ! -f "${DOCS_DIR}/markdown/API.md" ]; then
echo "Error: ${DOCS_DIR}/markdown/API.md not found"
echo "Run 'mise run docs:generate:markdown' first to generate markdown documentation"
exit 1
fi

if [ ! -d "${DOCS_DIR}/xml" ] || [ -z "$(ls -A ${DOCS_DIR}/xml/*.xml 2>/dev/null)" ]; then
echo "Error: ${DOCS_DIR}/xml/*.xml files not found"
echo "Run 'mise run docs:generate' first to generate XML documentation"
exit 1
fi



# Create output directory
mkdir -p "${OUTPUT_DIR}"

# Create archives
echo "Creating archives..."
cd "${DOCS_DIR}"

# Create ZIP archive
zip -r -q "../../${OUTPUT_DIR}/eql-docs-${VERSION}.zip" html/
# Create ZIP archive with all documentation formats
zip -r -q "../../${OUTPUT_DIR}/eql-docs-${VERSION}.zip" markdown/API.md xml/*.xml html/
echo "Created ${OUTPUT_DIR}/eql-docs-${VERSION}.zip"

# Create tarball
tar czf "../../${OUTPUT_DIR}/eql-docs-${VERSION}.tar.gz" html/
# Create tarball with all documentation formats
tar czf "../../${OUTPUT_DIR}/eql-docs-${VERSION}.tar.gz" markdown/API.md xml/ html/
echo "Created ${OUTPUT_DIR}/eql-docs-${VERSION}.tar.gz"

cd ../..
Expand Down
Loading