build_antora.sh: fix base-url patch, use mrdocs generated tagfile #47
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes the base-url patching mechanism in the Antora documentation build script and switches to using mrdocs-generated tagfiles instead of manually maintained ones. The changes include:
- Improved logic to detect repository and SHA information from CI environments (CircleCI and GitHub Actions)
- Updated dependency versions for Antora and related packages
- Removed manually maintained tagfile in favor of mrdocs-generated versions
- Minor configuration updates to exclude additional symbols and fix base URL
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/build_antora.sh | Enhanced base-url detection logic to properly handle Boost superproject scenarios with improved environment variable handling |
| doc/mrdocs.yml | Updated base-url from 'develop' to 'master' branch and added 'compiler' to exclude-symbols |
| doc/antora.yml | Removed manual tagfile configuration entries, switching to mrdocs-generated tagfiles |
| doc/package.json | Updated Antora and related package versions to latest compatible releases |
| doc/package-lock.json | Regenerated lockfile reflecting updated dependencies |
| doc/tagfiles/boost-openmethod-doxygen.tag.xml | Deleted manually maintained tagfile (907 lines removed) |
| include/boost/openmethod/preamble.hpp | Added blank line for formatting consistency |
Files not reviewed (1)
- doc/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| base_url="https://github.com/${repository}/blob/${sha}" | ||
| if [ -n "${BOOST_SRC_DIR:-}" ]; then | ||
| if [ -n "${CIRCLE_REPOSITORY_URL:-}" ]; then | ||
| if [[ "$CIRCLE_REPOSITORY_URL" =~ boostorg/boost(\.git)?$ ]]; then |
There was a problem hiding this comment.
The regex pattern should be anchored more carefully. The pattern boostorg/boost(\.git)?$ could match URLs like https://github.com/user/boostorg/boost.git. Consider using a more specific pattern like [:/]boostorg/boost(\.git)?$ to ensure proper matching.
| if [[ "$CIRCLE_REPOSITORY_URL" =~ boostorg/boost(\.git)?$ ]]; then | |
| if [[ "$CIRCLE_REPOSITORY_URL" =~ [:/]boostorg/boost(\.git)?$ ]]; then |
doc/build_antora.sh
Outdated
| LIB=$(basename "$(git rev-parse --show-toplevel)") | ||
| REPOSITORY="${ACCOUNT}/${LIB}" | ||
| fi | ||
| SHA=$(git -C "$BOOST_SRC_DIR/libs" ls-tree HEAD | grep openmethod | awk '{print $3}') |
There was a problem hiding this comment.
This command will fail silently if the git command fails or if 'openmethod' is not found. Add error handling: check the exit status and ensure SHA is not empty before proceeding. Consider using || true and then checking if SHA is empty, or use set -o pipefail to catch pipeline failures.
Co-authored-by: Copilot <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #47 +/- ##
========================================
Coverage 92.03% 92.03%
========================================
Files 40 40
Lines 2838 2838
Branches 1354 1354
========================================
Hits 2612 2612
Misses 187 187
Partials 39 39
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
1 participant
No description provided.