[DEV-4124] Implement dirNames fetching for manifest generation and Crowdin upload#209
Open
Sebastiano-Bertolin wants to merge 11 commits into
Conversation
…din upload, enhancing path management
…EV-4124-fetch-dirNames-from-buckets
…EV-4124-fetch-dirNames-from-buckets
…EV-4124-fetch-dirNames-from-buckets
…EV-4124-fetch-dirNames-from-buckets
Contributor
There was a problem hiding this comment.
Pull request overview
This PR changes the manifest and Crowdin config generation flow so the published dirNames.json list becomes the default source of documentation paths when no explicit workflow inputs are supplied.
Changes:
- Adds
DIR_NAMES_URLandfetchDirNamesPathsfor fetching canonical path inputs. - Updates both generation entry points to use dirNames fallback behavior.
- Updates TypeScript config and documentation for the new default flow.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/docsStructure.ts |
Adds dirNames URL/fetch helper and rebuild-from-selected-paths manifest option. |
src/generateDocStructure.ts |
Fetches dirNames and rebuilds the manifest when no upload/delete paths are provided. |
src/generateCrowdinConfig.ts |
Fetches dirNames for empty upload input and generates Crowdin entries from selected paths. |
src/README.md |
Documents the new dirNames fallback behavior. |
upload_sources_to_crowdin_workflow.md |
Adds workflow-level explanation of dirNames as the default source. |
tsconfig.json |
Updates TypeScript target/module settings. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…EV-4124-fetch-dirNames-from-buckets
…ces_to_crowdin workflow
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation and logic for the scripts that generate
docs-structure.jsonandcrowdin.yml, making the canonical list of documentation paths (dirNames.json) the new source of truth when no explicit path inputs are provided. Instead of scanning the entiredocs/directory by default, both scripts now fetch and use the paths fromdirNames.json, ensuring consistency and reducing unnecessary processing. The implementation includes new error handling, updated script entry points, and improved documentation.Key changes include:
Core Logic Changes:
PATHS_TO_UPLOADnorPATHS_TO_DELETEis provided, bothgenerateDocStructure.tsandgenerateCrowdinConfig.tsfetch the canonical list of paths fromdirNames.jsonand use only those for manifest and Crowdin config generation. Thedocs/directory is never scanned wholesale anymore. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]New Utility and API:
fetchDirNamesPathsfunction to fetch and validate the canonical paths fromDIR_NAMES_URL, with robust error handling for missing or malformed payloads. [1] [2] [3]Script Behavior and Error Handling:
Documentation Updates:
README.mdandupload_sources_to_crowdin_workflow.mdto reflect the new default behavior, describing how the canonical path list is used and clarifying script logic for all input scenarios. [1] [2] [3] [4] [5]Configuration and API Surface:
DIR_NAMES_URLas a constant and updated relevant interfaces and function signatures to support the new behavior. [1] [2]These changes ensure that only the intended documentation paths are processed and uploaded, improving reliability and maintainability.