Skip to content

Commit 932ea6f

Browse files
theekrystalleetheekrystallee
authored
docs: promote Networks to a top-level tab (#670)
Signed-off-by: krystal <56278409+theekrystallee@users.noreply.github.com>
1 parent 5b31a9f commit 932ea6f

97 files changed

Lines changed: 352 additions & 245 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/auto-release-notes.yml‎

Lines changed: 0 additions & 50 deletions
This file was deleted.

‎.github/workflows/consensus-node-release-notes.yml‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ concurrency:
2323
cancel-in-progress: false
2424

2525
env:
26-
TARGET: learn/release-notes/services.mdx
26+
TARGET: networks/release-notes/services.mdx
2727
REPO: hiero-ledger/hiero-consensus-node
2828

2929
jobs:
@@ -56,38 +56,38 @@ jobs:
5656
if [[ -n "${VERSION_INPUT}" ]]; then
5757
# Single-version mode: validate and use exactly the requested version.
5858
VERSION="${VERSION_INPUT#v}"
59-
if [[ ! "${VERSION}" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?$ ]]; then
59+
if [[ ! "${VERSION}" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?$ ]]; then
6060
echo "Invalid version: ${VERSION_INPUT}" >&2
6161
echo "Expected X.Y.Z or vX.Y.Z, for example 0.74.1 or v0.74.1." >&2
6262
exit 1
6363
fi
64-
echo "${VERSION}" > "${RUNNER_TEMP}/versions.txt"
64+
echo "${VERSION}" > "${RUNNER_TEMP}/versions.txt"
6565
else
6666
# Backfill mode: every stable release newer than the latest on the page.
6767
gh release list \
68-
--repo "${REPO}" \
68+
--repo "${REPO}" \
6969
--exclude-pre-releases \
7070
--exclude-drafts \
7171
--limit 100 \
7272
--json tagName \
73-
> "${RUNNER_TEMP}/releases.json"
73+
> "${RUNNER_TEMP}/releases.json"
7474
7575
node .github/scripts/select-backfill-versions.js \
76-
--target "${TARGET}" \
77-
--releases "${RUNNER_TEMP}/releases.json" \
78-
> "${RUNNER_TEMP}/versions.txt"
76+
--target "${TARGET}" \
77+
--releases "${RUNNER_TEMP}/releases.json" \
78+
> "${RUNNER_TEMP}/versions.txt"
7979
fi
8080
81-
COUNT="$(grep -c . "${RUNNER_TEMP}/versions.txt" || true)"
82-
echo "count=${COUNT}" >> "${GITHUB_OUTPUT}"
81+
COUNT="$(grep -c . "${RUNNER_TEMP}/versions.txt" || true)"
82+
echo "count=${COUNT}" >> "${GITHUB_OUTPUT}"
8383
84-
if [[ "${COUNT}" -eq 0 ]]; then
84+
if [[ "${COUNT}" -eq 0 ]]; then
8585
echo "No missing releases — nothing to do."
8686
else
8787
echo "Will add $COUNT release(s):"
88-
cat "${RUNNER_TEMP}/versions.txt"
88+
cat "${RUNNER_TEMP}/versions.txt"
8989
CSV="$(sed 's/^/v/' "$RUNNER_TEMP/versions.txt" | paste -sd, -)"
90-
echo "versions_csv=${CSV}" >> "${GITHUB_OUTPUT}"
90+
echo "versions_csv=${CSV}" >> "${GITHUB_OUTPUT}"
9191
fi
9292
9393
- name: Generate MDX entries
@@ -103,31 +103,31 @@ jobs:
103103
# Non-fatal: the script falls back to TODO dates if this is missing.
104104
curl -sSfL --max-time 30 \
105105
https://status.hedera.com/api/v2/scheduled-maintenances.json \
106-
> "${RUNNER_TEMP}/status.json" || echo '{}' > "${RUNNER_TEMP}/status.json"
106+
> "${RUNNER_TEMP}/status.json" || echo '{}' > "${RUNNER_TEMP}/status.json"
107107
108108
# Oldest-first so the newest release ends up prepended last (on top).
109109
while IFS= read -r VERSION; do
110-
[[ -z "${VERSION}" ]] && continue
110+
[[ -z "${VERSION}" ]] && continue
111111
echo "::group::v${VERSION}"
112112
gh release view "v${VERSION}" \
113-
--repo "${REPO}" \
113+
--repo "${REPO}" \
114114
--json body,tagName,url \
115-
> "${RUNNER_TEMP}/release.json"
115+
> "${RUNNER_TEMP}/release.json"
116116
117117
node .github/scripts/consensus-node-release-entry.js \
118-
--version "${VERSION}" \
119-
--release-json "${RUNNER_TEMP}/release.json" \
120-
--target "${TARGET}" \
121-
--status-json "${RUNNER_TEMP}/status.json"
122-
echo "::endgroup::"
123-
done < "${RUNNER_TEMP}/versions.txt"
118+
--version "${VERSION}" \
119+
--release-json "${RUNNER_TEMP}/release.json" \
120+
--target "${TARGET}" \
121+
--status-json "${RUNNER_TEMP}/status.json"
122+
echo "::endgroup::"
123+
done < "${RUNNER_TEMP}/versions.txt"
124124
125125
- name: Open pull request
126126
if: steps.plan.outputs.count != '0'
127127
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
128128
with:
129129
token: ${{ secrets.GITHUB_TOKEN }}
130-
add-paths: learn/release-notes/services.mdx
130+
add-paths: networks/release-notes/services.mdx
131131
commit-message: "docs: add consensus node release notes (${{ steps.plan.outputs.versions_csv }})"
132132
signoff: true
133133
sign-commits: true
@@ -149,5 +149,5 @@ jobs:
149149
- [ ] For any new minor release, fill in the scaffolded `## Release vX.Y` release highlights + "What's new" accordion
150150
- [ ] Confirm the auto-filled mainnet/testnet dates are correct (or fill any left as TODO if the status page had no date yet)
151151
- [ ] Confirm each build block landed under the correct minor section, in descending order
152-
- [ ] Check for breaking changes that warrant a callout
152+
- [ ] Check for breaking changes that warrant a callout
153153

‎.github/workflows/mirror-node-release-notes.yml‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ concurrency:
2323
cancel-in-progress: false
2424

2525
env:
26-
TARGET: learn/release-notes/mirror-node.mdx
26+
TARGET: networks/release-notes/mirror-node.mdx
2727
REPO: hiero-ledger/hiero-mirror-node
2828

2929
jobs:
@@ -56,39 +56,39 @@ jobs:
5656
if [[ -n "${VERSION_INPUT}" ]]; then
5757
# Single-version mode: validate and use exactly the requested version.
5858
VERSION="${VERSION_INPUT#v}"
59-
if [[ ! "${VERSION}" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?$ ]]; then
59+
if [[ ! "${VERSION}" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?$ ]]; then
6060
echo "Invalid version: ${VERSION_INPUT}" >&2
6161
echo "Expected X.Y.Z or vX.Y.Z, for example 0.155.1 or v0.155.1." >&2
6262
exit 1
6363
fi
64-
echo "${VERSION}" > "${RUNNER_TEMP}/versions.txt"
64+
echo "${VERSION}" > "${RUNNER_TEMP}/versions.txt"
6565
else
6666
# Backfill mode: every stable release newer than the latest on the page.
6767
gh release list \
68-
--repo "${REPO}" \
68+
--repo "${REPO}" \
6969
--exclude-pre-releases \
7070
--exclude-drafts \
7171
--limit 100 \
7272
--json tagName \
73-
> "${RUNNER_TEMP}/releases.json"
73+
> "${RUNNER_TEMP}/releases.json"
7474
7575
node .github/scripts/select-backfill-versions.js \
76-
--target "${TARGET}" \
77-
--releases "${RUNNER_TEMP}/releases.json" \
78-
> "${RUNNER_TEMP}/versions.txt"
76+
--target "${TARGET}" \
77+
--releases "${RUNNER_TEMP}/releases.json" \
78+
> "${RUNNER_TEMP}/versions.txt"
7979
fi
8080
81-
COUNT="$(grep -c . "${RUNNER_TEMP}/versions.txt" || true)"
82-
echo "count=${COUNT}" >> "${GITHUB_OUTPUT}"
81+
COUNT="$(grep -c . "${RUNNER_TEMP}/versions.txt" || true)"
82+
echo "count=${COUNT}" >> "${GITHUB_OUTPUT}"
8383
8484
if [[ "$COUNT" -eq 0 ]]; then
8585
echo "No missing releases — nothing to do."
8686
else
8787
echo "Will add $COUNT release(s):"
88-
cat "${RUNNER_TEMP}/versions.txt"
89-
# Comma-separated v-prefixed list for the PR title/commit message.
90-
CSV="$(sed 's/^/v/' "${RUNNER_TEMP}/versions.txt" | paste -sd, -)"
91-
echo "versions_csv=${CSV}" >> "${GITHUB_OUTPUT}"
88+
cat "${RUNNER_TEMP}/versions.txt"
89+
# Comma-separated v-prefixed list for the PR title/commit message.
90+
CSV="$(sed 's/^/v/' "${RUNNER_TEMP}/versions.txt" | paste -sd, -)"
91+
echo "versions_csv=${CSV}" >> "${GITHUB_OUTPUT}"
9292
fi
9393
9494
- name: Generate MDX entries
@@ -101,26 +101,26 @@ jobs:
101101
102102
# Oldest-first so the newest release ends up prepended last (on top).
103103
while IFS= read -r VERSION; do
104-
[[ -z "${VERSION}" ]] && continue
104+
[[ -z "${VERSION}" ]] && continue
105105
echo "::group::v${VERSION}"
106106
gh release view "v${VERSION}" \
107-
--repo "${REPO}" \
108-
--json body,tagName,url \
109-
> "${RUNNER_TEMP}/release.json"
107+
--repo "${REPO}" \
108+
--json body,tagName,url \
109+
> "${RUNNER_TEMP}/release.json"
110110
111111
node .github/scripts/mirror-node-release-entry.js \
112-
--version "${VERSION}" \
113-
--release-json "${RUNNER_TEMP}/release.json" \
114-
--target "${TARGET}"
115-
echo "::endgroup::"
116-
done < "${RUNNER_TEMP}/versions.txt"
112+
--version "${VERSION}" \
113+
--release-json "${RUNNER_TEMP}/release.json" \
114+
--target "${TARGET}"
115+
echo "::endgroup::"
116+
done < "${RUNNER_TEMP}/versions.txt"
117117
118118
- name: Open pull request
119119
if: steps.plan.outputs.count != '0'
120120
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
121121
with:
122122
token: ${{ secrets.GITHUB_TOKEN }}
123-
add-paths: learn/release-notes/mirror-node.mdx
123+
add-paths: networks/release-notes/mirror-node.mdx
124124
commit-message: "docs: add mirror node release notes (${{ steps.plan.outputs.versions_csv }})"
125125
signoff: true
126126
sign-commits: true

0 commit comments

Comments
 (0)