Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Inject analytics script into rustdocs #14805

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Inject analytics script into rustdocs #14805

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3a2ff8
inject sa script to rustdocs
liamaharon Aug 22, 2023
21cc105
typo
liamaharon Aug 22, 2023
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
17 changes: 17 additions & 0 deletions .maintain/rustdocs-release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,22 @@ build_rustdocs() {
&& echo "<meta http-equiv=refresh content=0;url=${DOC_INDEX_PAGE}>" > "${2}/index.html"
}

inject_analytics_script() {
local path="$1"
local script_content="<script async defer src=\"https://apisa.parity.io/latest.js\"></script><noscript><img src=\"https://apisa.parity.io/latest.js\" alt=\"\" referrerpolicy=\"no-referrer-when-downgrade\" /></noscript>"
liamaharon marked this conversation as resolved.
Show resolved Hide resolved

# Define a function that injects our script into the head of an html file.
process_file() {
local file="$1"
echo "Adding Simple Analytics script to $file"
sed -i "s|</head>|$script_content</head>|" "$file"
}
export -f process_file

# Locate all .html files under the documentation root and use xargs to process in parallel.
find "$path" -name '*.html' | xargs -I {} -P "$(nproc)" bash -c 'process_file "$@"' _ {}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is nproc expected to be installed in this environment? Can you test it in a CI or where is this normally run?

}

upsert_index_page() {
# Check if `index-tpl-crud` exists
which index-tpl-crud &> /dev/null || yarn global add @substrate/index-tpl-crud
Expand Down Expand Up @@ -139,6 +155,7 @@ deploy_main() {
git fetch --all
git checkout -f ${BUILD_RUSTDOC_REF} || { echo "Checkout \`${BUILD_RUSTDOC_REF}\` error." && exit 1; }
build_rustdocs "${BUILD_RUSTDOC_REF}" "${DOC_PATH}"
inject_analytics_script "${DOC_PATH}"

# git checkout `gh-pages` branch
git fetch "${GIT_REMOTE}" gh-pages
Expand Down