Add collection management scripts for MOH TOSP #955
+480
−0
Conversation
This file contains 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
harishv7
changed the title
Datadog ReportBranch report: ✅ 0 Failed, 245 Passed, 36 Skipped, 47.51s Total Time |
harishv7
force-pushed
the
12-23-tosp_migration_scripts
branch
from
83602e1 to
539a9c1
Compare
adriangohjw
reviewed
Dec 26, 2024
There was a problem hiding this comment.
Since this will only be used once a year:
- (nit) Use Generated Enums: Let's consider using generatedEnums (like ResourceType.Collection) instead of hardcoded strings. This will help keep the file updated with future changes, especially since it lacks tests.
- (nit) Keyword Arguments: Since many functions have multiple parameters, using keyword arguments over positional arguments might enhance clarity and safety.
- Add a README: Could you please add a simple README outlining the expected folder structure and usage steps? This will be helpful since this script is run infrequently.
Thank you!
| import { FileLogger } from "../FileLogger" | ||
|
|
||
| // Update the logger path if required | ||
| const logger = new FileLogger("./publishCollectionById.log") |
There was a problem hiding this comment.
nit - should be publishDraftCollection.log for consistency across files
| export const createCollectionFromLocal = async ( | ||
| contentDir: string, | ||
| siteId: number, | ||
| indexPageName: string, // should be placed outside the folder |
There was a problem hiding this comment.
not sure if i understand why this should be placed outside the folder?
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.
Problem
Needed scripts to manage collection resources in the database for content migration.
Closes ISOM-1700
Solution
Breaking Changes
Features:
New scripts:
backupCollectionById.ts: Backs up a collection and its resources to JSON filescreateCollectionFromLocal.ts: Creates a new collection from local JSON contentdeleteCollectionById.ts: Safely deletes a collection and all associated resourcespublishDraftCollection.ts: Publishes a draft collection and its child resourcesTests
Scripts should be tested with:
Each script includes error handling and transaction support to maintain data integrity.