Revert "chore: Remove calculated hash for original zh file in docs" #2
Conversation
This reverts commit fc99e99.
|
Caution Review failedThe pull request is closed. WalkthroughA Changes
Sequence Diagram(s)No sequence diagram generated as the changes are metadata additions without control flow impact. Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR reverts the previous removal of sourceSHA metadata and restores the calculated hash entries in the frontmatter of multiple documentation files.
- Re-inserts
sourceSHAfrontmatter field across various docs files - Ensures original source hashes are tracked for localization and tooling
- Applies uniformly to all
.mdxand relevant.mdfiles underdocs/en
Reviewed Changes
Copilot reviewed 52 out of 52 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/en/triggers/trouble_shooting/pipeline_not_triggered.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/triggers/trouble_shooting/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/triggers/quick_start.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/triggers/intro.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/triggers/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/triggers/architecture.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/results/quick_start.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/results/permissions.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/results/intro.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/results/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/results/concepts/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/results/architecture.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/overview/intro.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/overview/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/overview/features.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/hub/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/hub/architecture.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/how_to/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/how_to/deploy_global.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/development/update-frontend/index.md | Re-adds sourceSHA to frontmatter |
| docs/en/development/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/development/component-quickstart/index.md | Re-adds sourceSHA to frontmatter |
| docs/en/configure/pruner_resources.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/configure/customize_tekton_pipeline.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/configure/customize_options.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/triggers/triggertemplate.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/triggers/triggers.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/triggers/triggerbinding.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/triggers/interceptor.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/triggers/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/triggers/eventlistener.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/triggers/clustertriggerbinding.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/triggers/clusterinterceptor.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/operator/tektontriggers.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/operator/tektonresults.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/operator/tektonpipelines.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/operator/tektoninstallersets.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/operator/tektoninstallerset.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/operator/tektonhubs.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/operator/tektonconfig.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/operator/tektonchains.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/operator/openshiftpipelinesascodes.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/kubernetes_apis/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/intro.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/index.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results_uuid_records.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results_uuid_logs.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results_uuid.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results.mdx | Re-adds sourceSHA to frontmatter |
| docs/en/apis/advanced_apis/results/intro.md | Re-adds sourceSHA to frontmatter |
| docs/en/apis/advanced_apis/results/index.mdx | Re-adds sourceSHA to frontmatter |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
docs/en/apis/kubernetes_apis/operator/tektonchains.mdx (1)
3-3: Same quoting nitpick as noted forclusterinterceptor.mdxApply the quoted form for consistency.
docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results_uuid.mdx (1)
3-3: Same quoting nitpick as noted earlierdocs/en/apis/kubernetes_apis/triggers/clustertriggerbinding.mdx (1)
3-3: Same quoting nitpick as noted earlierdocs/en/apis/kubernetes_apis/operator/tektonhubs.mdx (1)
3-3: Same quoting nitpick as noted earlier
🧹 Nitpick comments (12)
docs/en/development/component-quickstart/index.md (2)
237-243: Trailing whitespace introduces noisy diffs.Line 239 now ends with an extra space after the colon (
# TL;DR:·).
Markdown/YAML comments don’t need this padding, and linters may flag it.- # TL;DR: + # TL;DR:
333-337: Same trailing-space nit on the “Important” comment.- # **Important** Update the component's version number + # **Important** Update the component's version numberdocs/en/overview/intro.mdx (1)
3-3: AutomatesourceSHAgeneration to prevent manual driftA hard-coded hash will inevitably go stale after the next change to the referenced source. Consider generating / injecting this field during the docs build (e.g. a pre-commit or CI step) instead of committing literal values.
docs/en/overview/index.mdx (1)
3-3: Confirm the accuracy & maintenance strategy forsourceSHAPlease verify that the stored hash actually corresponds to the latest upstream source and document how the field will be updated going forward. Without automation, the metadata risks becoming misleading.
docs/en/overview/features.mdx (1)
3-3:sourceSHAlooks correct (64-char hex) — but add contextThe value format is valid, yet new contributors won’t know why it exists. A short comment in CONTRIBUTING or a docs-build helper script would improve maintainability and reduce accidental removal (the original change you’re reverting).
docs/en/results/permissions.mdx (1)
3-3: Quote the SHA to avoid YAML edge-cases.While plain scalars are usually fine, wrapping long hexadecimal strings in quotes guards against future YAML parsers that might attempt type-coercion or line-folding.
-sourceSHA: 80a7ecd66cd9ce5252ddc1a40ce65ee072b136b380fa43cd5b062ff6face24ae +sourceSHA: "80a7ecd66cd9ce5252ddc1a40ce65ee072b136b380fa43cd5b062ff6face24ae"docs/en/apis/kubernetes_apis/operator/tektontriggers.mdx (1)
3-3: Consistently quote new front-matter hashes.Same rationale as above; quoting avoids any YAML parsing surprises and keeps formatting consistent with string values elsewhere in the docs set.
-sourceSHA: d43739dfcdf60af7b7725ad2689c0a3c99edc001e00afd7477d7725e3e5bfb28 +sourceSHA: "d43739dfcdf60af7b7725ad2689c0a3c99edc001e00afd7477d7725e3e5bfb28"docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results_uuid_logs.mdx (1)
3-3: Quote the hexadecimalsourceSHAvalue.For clarity and safer YAML parsing:
-sourceSHA: ee8963e55cef330bd194bf9494040e9577b6cba601438da14947fc007822eb67 +sourceSHA: "ee8963e55cef330bd194bf9494040e9577b6cba601438da14947fc007822eb67"docs/en/apis/kubernetes_apis/triggers/eventlistener.mdx (1)
3-3: Minor YAML style refinement – add quotes.-sourceSHA: fef4fe40c508978d994e33a72a894cbc55a51ddeea8d8edbf8c101a918eccca4 +sourceSHA: "fef4fe40c508978d994e33a72a894cbc55a51ddeea8d8edbf8c101a918eccca4"docs/en/apis/kubernetes_apis/triggers/interceptor.mdx (1)
3-3: Apply quoting for consistency across docs.-sourceSHA: 33f190e458d23fcfeea927fa32926bba930cfb83b325da0a6cd5865b8bd1e617 +sourceSHA: "33f190e458d23fcfeea927fa32926bba930cfb83b325da0a6cd5865b8bd1e617"docs/en/apis/kubernetes_apis/triggers/clusterinterceptor.mdx (1)
3-3: Quote the hash to avoid YAML edge-casesUnquoted, the scalar parses fine today, but quoting prevents any accidental numeric interpretation by stricter linters and keeps front-matter style uniform.
-sourceSHA: cb56559a5db99722832c6fe2418b634f07a96ebf9e0210182b3a5fd7ee1afe6a +sourceSHA: "cb56559a5db99722832c6fe2418b634f07a96ebf9e0210182b3a5fd7ee1afe6a"docs/en/triggers/trouble_shooting/pipeline_not_triggered.mdx (1)
22-31: Minor wording & whitespace nitpicksWhile touching this block you can fix two quick issues:
-## Problem Investigation +## Problem Investigation -### Webhook configuration was not setup correctly +### Webhook configuration was not set up correctly - 3. Make sure the required events are enabled by the webhook. For Gitlab events please refer to [GitLab Event Triggers](../how_to/gitlab_events.mdx) + 3. Make sure the required events are enabled by the webhook. For GitLab events, please refer to [GitLab Event Triggers](../how_to/gitlab_events.mdx) - +• “set up” is the correct verb form.
• Added the missing comma after an introductory clause.
• Removed trailing whitespace.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (52)
docs/en/apis/advanced_apis/results/index.mdx(1 hunks)docs/en/apis/advanced_apis/results/intro.md(1 hunks)docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results.mdx(1 hunks)docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results_uuid.mdx(1 hunks)docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results_uuid_logs.mdx(1 hunks)docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results_uuid_records.mdx(1 hunks)docs/en/apis/index.mdx(1 hunks)docs/en/apis/intro.mdx(1 hunks)docs/en/apis/kubernetes_apis/index.mdx(1 hunks)docs/en/apis/kubernetes_apis/operator/openshiftpipelinesascodes.mdx(1 hunks)docs/en/apis/kubernetes_apis/operator/tektonchains.mdx(1 hunks)docs/en/apis/kubernetes_apis/operator/tektonconfig.mdx(1 hunks)docs/en/apis/kubernetes_apis/operator/tektonhubs.mdx(1 hunks)docs/en/apis/kubernetes_apis/operator/tektoninstallerset.mdx(1 hunks)docs/en/apis/kubernetes_apis/operator/tektoninstallersets.mdx(1 hunks)docs/en/apis/kubernetes_apis/operator/tektonpipelines.mdx(1 hunks)docs/en/apis/kubernetes_apis/operator/tektonresults.mdx(1 hunks)docs/en/apis/kubernetes_apis/operator/tektontriggers.mdx(1 hunks)docs/en/apis/kubernetes_apis/triggers/clusterinterceptor.mdx(1 hunks)docs/en/apis/kubernetes_apis/triggers/clustertriggerbinding.mdx(1 hunks)docs/en/apis/kubernetes_apis/triggers/eventlistener.mdx(1 hunks)docs/en/apis/kubernetes_apis/triggers/index.mdx(1 hunks)docs/en/apis/kubernetes_apis/triggers/interceptor.mdx(1 hunks)docs/en/apis/kubernetes_apis/triggers/triggerbinding.mdx(1 hunks)docs/en/apis/kubernetes_apis/triggers/triggers.mdx(1 hunks)docs/en/apis/kubernetes_apis/triggers/triggertemplate.mdx(1 hunks)docs/en/configure/customize_options.mdx(1 hunks)docs/en/configure/customize_tekton_pipeline.mdx(1 hunks)docs/en/configure/pruner_resources.mdx(1 hunks)docs/en/development/component-quickstart/index.md(3 hunks)docs/en/development/index.mdx(1 hunks)docs/en/development/update-frontend/index.md(1 hunks)docs/en/how_to/deploy_global.mdx(1 hunks)docs/en/how_to/index.mdx(1 hunks)docs/en/hub/architecture.mdx(1 hunks)docs/en/hub/index.mdx(1 hunks)docs/en/index.mdx(1 hunks)docs/en/overview/features.mdx(1 hunks)docs/en/overview/index.mdx(1 hunks)docs/en/overview/intro.mdx(1 hunks)docs/en/results/architecture.mdx(1 hunks)docs/en/results/concepts/index.mdx(1 hunks)docs/en/results/index.mdx(1 hunks)docs/en/results/intro.mdx(1 hunks)docs/en/results/permissions.mdx(1 hunks)docs/en/results/quick_start.mdx(1 hunks)docs/en/triggers/architecture.mdx(1 hunks)docs/en/triggers/index.mdx(1 hunks)docs/en/triggers/intro.mdx(1 hunks)docs/en/triggers/quick_start.mdx(1 hunks)docs/en/triggers/trouble_shooting/index.mdx(1 hunks)docs/en/triggers/trouble_shooting/pipeline_not_triggered.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/en/triggers/trouble_shooting/pipeline_not_triggered.mdx
[grammar] ~26-~26: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...em: ### Webhook configuration was not setup correctly 1. Access your repository...
(BE_VB_OR_NN)
[typographical] ~30-~30: Consider adding a comma here.
Context: ...nabled by the webhook. For Gitlab events please refer to [GitLab Event Triggers](../how...
(PLEASE_COMMA)
🔇 Additional comments (37)
docs/en/how_to/deploy_global.mdx (1)
4-4:sourceSHAmetadata added correctlyThe 64-character commit hash is well-formed, and the front-matter remains valid YAML. No issues found.
docs/en/index.mdx (1)
2-2: Front-matter addition looks good
sourceSHAis a simple string value, valid YAML, and aligns with the pattern used in other files. No further action required.docs/en/apis/kubernetes_apis/operator/tektoninstallersets.mdx (1)
2-4: sourceSHA front-matter field re-added correctlyThe re-addition of the
sourceSHAfield restores traceability metadata without affecting the rendered content. The 64-char value matches a SHA-256 format and the key naming is consistent with the rest of the docs set. No further action needed.docs/en/configure/customize_tekton_pipeline.mdx (1)
4-4: Front-matter metadata re-addition looks goodThe
sourceSHAfield is correctly reintroduced and the YAML front-matter remains syntactically valid.docs/en/how_to/index.mdx (1)
3-7: YAML front-matter change looks correct.The
sourceSHAfield is added at the root level, so the YAML remains valid and should be parsed by the docs tooling without issues. No further action required.docs/en/apis/kubernetes_apis/operator/openshiftpipelinesascodes.mdx (1)
3-3:sourceSHAfront-matter field looks goodYAML syntax is valid and the hash is treated as a plain scalar; no further action needed.
docs/en/configure/pruner_resources.mdx (1)
4-4: Confirm SHA length / format aligns with expectedsourceSHAspecThe value is a 64-character hex string, whereas Git commit hashes are typically 40 characters.
If your docs tooling validates this field (e.g., for lookup or link-back), double-check that the longer SHA is actually recognised and not treated as invalid/unused metadata.docs/en/development/update-frontend/index.md (1)
3-3: VerifysourceSHAformatThe value is 64 hex characters, whereas standard Git commit SHAs are 40. Confirm the hash length is intentional (e.g., SHA-256) and that any tooling consuming this metadata supports it.
docs/en/development/component-quickstart/index.md (1)
3-4: Check validity & format of the addedsourceSHA.A Git commit hash is usually 40 hex chars (SHA-1) or 64 hex chars when SHA-256 repos are enabled.
Before relying on this metadata downstream, please confirm:
- The value really exists in the history of the upstream repo.
- The field name (
sourceSHA) is documented/standard across the docs site so that tools can consume it consistently.- If consumers parse YAML strictly, consider quoting the hash to avoid future parser edge-cases.
docs/en/configure/customize_options.mdx (1)
4-4: All documentation files includesourceSHAmetadata – consistency confirmed
Verified that every.mdand.mdxunderdocs/has a 64-charactersourceSHA:entry. No missing fields detected.docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results.mdx (1)
3-3:sourceSHAfront-matter addition looks goodNo issues spotted; syntax is valid and keeps front-matter ordering consistent with other docs.
docs/en/apis/index.mdx (1)
6-6: Metadata addition accepted
sourceSHAinserted correctly; no further action required.docs/en/hub/index.mdx (1)
3-3: Front-matter update OKSHA field follows the same pattern as the rest of the revert. Looks fine.
docs/en/apis/kubernetes_apis/triggers/triggerbinding.mdx (1)
3-3: ConsistentsourceSHAaddition – LGTMField added without disrupting existing content.
docs/en/apis/intro.mdx (1)
3-3: Re-addingsourceSHAfront-matter looks goodRestores the previously-removed metadata for traceability without affecting rendered content.
docs/en/results/intro.mdx (1)
3-3:sourceSHAmetadata reinstated successfullyConsistent with the revert’s goal; no further action required.
docs/en/results/index.mdx (1)
2-2: Front-matter hash restoredAlignment with other docs confirmed; change is harmless.
docs/en/hub/architecture.mdx (1)
3-3: Traceability hash reintroduced correctlyThe addition follows the same pattern as the rest of the revert set.
docs/en/apis/kubernetes_apis/operator/tektonresults.mdx (1)
3-3: Hash field restoration verifiedMatches the repository-wide metadata scheme; looks fine.
docs/en/apis/kubernetes_apis/operator/tektonconfig.mdx (1)
3-3:sourceSHAfield addition is syntactically correctFront-matter stays valid YAML/TOML, the 64-char SHA looks well-formed. No further action needed.
docs/en/results/architecture.mdx (1)
3-3: Front-matter metadata looks goodThe new
sourceSHAhash is properly inserted and preserves the existing front-matter structure.docs/en/apis/kubernetes_apis/index.mdx (1)
2-2: Confirmed valid hash additionNothing else changed; build tooling should ingest the new field without side-effects.
docs/en/apis/kubernetes_apis/operator/tektonpipelines.mdx (1)
3-3: Metadata update accepted
sourceSHAentry complies with the format adopted across the docs.docs/en/apis/kubernetes_apis/triggers/triggertemplate.mdx (1)
3-3: Consistent front-matter enhancementThe added hash follows the same convention; no issues found.
docs/en/apis/advanced_apis/results/index.mdx (1)
6-6: Front-matter metadata addition looks good
sourceSHAis added as a plain scalar; since the value contains hexadecimal letters, YAML will treat it as a string, so no quoting is strictly required.
No further issues spotted.docs/en/apis/advanced_apis/results/intro.md (1)
4-4: Consistent metadata – all goodThe added
sourceSHAfollows the same pattern as other docs files. ✅docs/en/apis/kubernetes_apis/triggers/triggers.mdx (1)
3-3: LGTMNothing to flag; the new front-matter key is syntactically valid YAML.
docs/en/results/concepts/index.mdx (1)
6-6: Metadata addition accepted
sourceSHAcorrectly lives at top-level of the front-matter block. No further action needed.docs/en/results/quick_start.mdx (1)
3-3: No issues with the newsourceSHAentryChange is safe and keeps the front-matter valid. 👍
docs/en/apis/kubernetes_apis/operator/tektoninstallerset.mdx (1)
3-3:sourceSHAfront-matter entry added – looks goodYAML syntax and ordering are valid; no functional impact beyond traceability. ✅
docs/en/apis/kubernetes_apis/triggers/index.mdx (1)
6-6:sourceSHAfield correctly insertedIndentation level and placement keep the front-matter valid; no further action required.
docs/en/triggers/index.mdx (1)
2-2: Traceability metadata acceptedThe added commit hash is well-formed and the front-matter remains syntactically correct.
docs/en/triggers/intro.mdx (1)
3-3: Addition ofsourceSHAis fineConsistent with other docs; YAML stays valid. No issues spotted.
docs/en/triggers/quick_start.mdx (1)
3-3: No concerns with the newsourceSHAentryHash format and placement are correct; documentation builds should remain unaffected.
docs/en/triggers/architecture.mdx (1)
3-3:sourceSHAfront-matter looks fine – just ensure the value is what you expectNothing else changed in this file. 64-char hashes are acceptable, but double-check it actually maps to a relevant commit/tag; otherwise it’s just noise in version control history.
docs/en/triggers/trouble_shooting/index.mdx (1)
6-6: Consistent metadata 👍
sourceSHAis placed at the correct indentation level and doesn’t break the YAML structure.docs/en/development/index.mdx (1)
4-4: ConfirmsourceSHAmatches latest upstream Chinese commit
No Chinese counterpart fordocs/development/index.mdxwas found in this repo (e.g.docs/zh/development/index.mdx), so the hash75c34d0d72e02898d2113ea25e4d650c5813026359d0fbe191f5f0a4003ea1d0could not be validated.
Please manually:
- Locate the current Chinese source file upstream.
- Retrieve its latest commit SHA.
- Update the
sourceSHAindocs/en/development/index.mdxif it has changed.
| @@ -1,5 +1,6 @@ | |||
| --- | |||
| weight: 300 | |||
| sourceSHA: da1c16d39fd92f75e46aaa6298dd383507ab0f1931f81a700a6140c12e918afc | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify consistency/uniqueness of all newly-added sourceSHA values
This SHA looks fine syntactically, but because dozens of files just received a sourceSHA it’s easy to accidentally paste the same hash twice or introduce a typo.
Suggest running a quick check across the repo to detect duplicates or malformed hashes.
The expected output should be empty; any line printed indicates a duplicate that should be fixed.
🏁 Script executed:
#!/bin/bash
# 1. List every `sourceSHA` we now have.
rg --no-heading --line-number '^sourceSHA:' docs | sort > /tmp/all_sha.txt
# 2. Show any duplicates (lines appearing more than once).
cut -d':' -f3 /tmp/all_sha.txt | sort | uniq -dLength of output: 115
Update the duplicate-sourceSHA check script
The current script’s cut -d':' -f3 extracts the literal sourceSHA token (hence the “duplicate”), not the SHA value. Adjust it to pull the actual hash. For example:
#!/bin/bash
# Extract only the SHA values, then look for repeats
rg --no-heading '^sourceSHA:' docs \
| awk -F': ' '{print $2}' \
| sort \
| uniq -dOr using ripgrep’s PCRE support:
#!/bin/bash
rg -oP 'sourceSHA:\s*\K[0-9a-f]+' docs \
| sort \
| uniq -dAny output indicates a duplicate SHA that should be corrected.
🤖 Prompt for AI Agents
In
docs/en/apis/advanced_apis/results/results_v1alpha2_parents_results_uuid_records.mdx
at line 3, the duplicate-`sourceSHA` check script incorrectly extracts the
literal token "sourceSHA" instead of the actual SHA value. Fix this by modifying
the script to extract the SHA hash after the colon, for example, using awk with
field separator ': ' to print the second field or using ripgrep with a regex
that captures only the SHA hash. This ensures the script correctly identifies
duplicate SHA values.
Reverts #1
Summary by CodeRabbit
Documentation
Chores