fix: keep docs/README indicator count in sync-about (#131)
* fix: keep docs/README indicator count in sync-about
The docs/README.md pointer prose names the indicator count
("**N indicators**") but was never part of the sync-about counter
pipeline, so it drifted to 214 while the real count (lib.rs) is 249.
Add docs/README.md to the PR-flow gate check, the patch sed, and the
fix-up commit so future count changes keep it in sync, and correct the
current stale value to 249.
* docs: fix stale Wiki reference in CONTRIBUTING layout table
The project-layout table still described docs/ as a "Pointer to the
project Wiki" even though the wiki was retired and the docs moved to
docs.wickra.org (wickra-lib/wickra-docs). Align the row with the
already-correct doc-site section further down the same file.
This commit is contained in:
@@ -144,19 +144,20 @@ jobs:
|
|||||||
id: pr_check
|
id: pr_check
|
||||||
run: |
|
run: |
|
||||||
n="${{ steps.count.outputs.count }}"
|
n="${{ steps.count.outputs.count }}"
|
||||||
if grep -qE "^${n} streaming-first indicators" README.md; then
|
if grep -qE "^${n} streaming-first indicators" README.md \
|
||||||
|
&& grep -qE "\*\*${n} indicators\*\*" docs/README.md; then
|
||||||
echo "matches=true" >> "$GITHUB_OUTPUT"
|
echo "matches=true" >> "$GITHUB_OUTPUT"
|
||||||
echo "README counter already at ${n}; nothing to do."
|
echo "README + docs/README counter already at ${n}; nothing to do."
|
||||||
else
|
else
|
||||||
echo "matches=false" >> "$GITHUB_OUTPUT"
|
echo "matches=false" >> "$GITHUB_OUTPUT"
|
||||||
echo "README counter does not match ${n}; will fix up."
|
echo "README/docs counter does not match ${n}; will fix up."
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- name: Fix counter on fork PR head (read-only, fail loud)
|
- name: Fix counter on fork PR head (read-only, fail loud)
|
||||||
if: github.event_name == 'pull_request' && steps.pr_check.outputs.matches == 'false' && steps.ctx.outputs.can_push == 'false'
|
if: github.event_name == 'pull_request' && steps.pr_check.outputs.matches == 'false' && steps.ctx.outputs.can_push == 'false'
|
||||||
run: |
|
run: |
|
||||||
n="${{ steps.count.outputs.count }}"
|
n="${{ steps.count.outputs.count }}"
|
||||||
echo "::error::README.md says a different indicator count than mod.rs (${n}). This PR is from a fork, so the workflow cannot push the fix; please update README.md to '${n} streaming-first indicators' and push again."
|
echo "::error::README.md / docs/README.md say a different indicator count than lib.rs (${n}). This PR is from a fork, so the workflow cannot push the fix; please set README.md to '${n} streaming-first indicators' and docs/README.md to '**${n} indicators**', then push again."
|
||||||
exit 1
|
exit 1
|
||||||
|
|
||||||
- name: Patch README on PR head
|
- name: Patch README on PR head
|
||||||
@@ -164,10 +165,12 @@ jobs:
|
|||||||
id: pr_patch
|
id: pr_patch
|
||||||
run: |
|
run: |
|
||||||
n="${{ steps.count.outputs.count }}"
|
n="${{ steps.count.outputs.count }}"
|
||||||
sed -i -E "s/[0-9]+ (streaming-first )?indicators/${n} \1indicators/g" README.md
|
# docs/README.md carries the count in its docs.wickra.org pointer prose
|
||||||
|
# ("**N indicators**"); keep it in sync with README's prose count.
|
||||||
|
sed -i -E "s/[0-9]+ (streaming-first )?indicators/${n} \1indicators/g" README.md docs/README.md
|
||||||
# Bump the banner cache-buster so GitHub's Camo proxy refetches the org
|
# Bump the banner cache-buster so GitHub's Camo proxy refetches the org
|
||||||
# profile image (regenerated with the new count by .github/banner.yml)
|
# profile image (regenerated with the new count by .github/banner.yml)
|
||||||
# instead of serving a stale cached copy.
|
# instead of serving a stale cached copy. (README only — docs has no banner.)
|
||||||
sed -i -E "s|(wickra-banner\.webp\?v=)[0-9]+|\1${n}|" README.md
|
sed -i -E "s|(wickra-banner\.webp\?v=)[0-9]+|\1${n}|" README.md
|
||||||
if git diff --quiet; then
|
if git diff --quiet; then
|
||||||
echo "No README changes after sed (counter regex did not match anything); skipping push."
|
echo "No README changes after sed (counter regex did not match anything); skipping push."
|
||||||
@@ -187,7 +190,7 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
git config user.name "wickra-bot"
|
git config user.name "wickra-bot"
|
||||||
git config user.email "wickra-bot@users.noreply.github.com"
|
git config user.email "wickra-bot@users.noreply.github.com"
|
||||||
git add README.md
|
git add README.md docs/README.md
|
||||||
git commit -m "chore: sync indicator count to ${COUNT}"
|
git commit -m "chore: sync indicator count to ${COUNT}"
|
||||||
git push origin "HEAD:${HEAD_REF}"
|
git push origin "HEAD:${HEAD_REF}"
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ when proposing features or depending on Wickra elsewhere.
|
|||||||
| `bindings/node` | napi-rs bindings (`wickra` on npm). |
|
| `bindings/node` | napi-rs bindings (`wickra` on npm). |
|
||||||
| `bindings/wasm` | wasm-bindgen bindings (`wickra-wasm` on npm). |
|
| `bindings/wasm` | wasm-bindgen bindings (`wickra-wasm` on npm). |
|
||||||
| `examples/` | Runnable examples. |
|
| `examples/` | Runnable examples. |
|
||||||
| `docs/` | Pointer to the project Wiki, which holds all documentation. |
|
| `docs/` | Pointer to the documentation site (docs.wickra.org); the docs live in the `wickra-lib/wickra-docs` repo. |
|
||||||
|
|
||||||
## Building and testing
|
## Building and testing
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -8,7 +8,7 @@ That includes:
|
|||||||
[Python](https://docs.wickra.org/Quickstart-Python),
|
[Python](https://docs.wickra.org/Quickstart-Python),
|
||||||
[Node](https://docs.wickra.org/Quickstart-Node), and
|
[Node](https://docs.wickra.org/Quickstart-Node), and
|
||||||
[WASM](https://docs.wickra.org/Quickstart-WASM).
|
[WASM](https://docs.wickra.org/Quickstart-WASM).
|
||||||
- A per-indicator deep dive for every one of the **214 indicators** across
|
- A per-indicator deep dive for every one of the **249 indicators** across
|
||||||
the sixteen families (Moving Averages, Momentum Oscillators, Trend &
|
the sixteen families (Moving Averages, Momentum Oscillators, Trend &
|
||||||
Directional, Price Oscillators, Volatility & Bands, Bands & Channels,
|
Directional, Price Oscillators, Volatility & Bands, Bands & Channels,
|
||||||
Trailing Stops, Volume, Price Statistics, Ehlers / Cycle DSP, Pivots &
|
Trailing Stops, Volume, Price Statistics, Ehlers / Cycle DSP, Pivots &
|
||||||
|
|||||||
Reference in New Issue
Block a user