Skip to content

Commit f242670

Browse files
authored
Merge pull request #150 from cipherstash/fix-doc-package
fix(docs): include markdown and XML in package archives
2 parents 23a8d6f + df8b9fd commit f242670

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

tasks/docs/package.sh

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,33 @@ if [ ! -f "${DOCS_DIR}/html/index.html" ]; then
1616
exit 1
1717
fi
1818

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

25+
if [ ! -d "${DOCS_DIR}/xml" ] || [ -z "$(ls -A ${DOCS_DIR}/xml/*.xml 2>/dev/null)" ]; then
26+
echo "Error: ${DOCS_DIR}/xml/*.xml files not found"
27+
echo "Run 'mise run docs:generate' first to generate XML documentation"
28+
exit 1
29+
fi
30+
31+
32+
2533
# Create output directory
2634
mkdir -p "${OUTPUT_DIR}"
2735

2836
# Create archives
2937
echo "Creating archives..."
3038
cd "${DOCS_DIR}"
3139

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

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

4048
cd ../..

0 commit comments

Comments
 (0)