klesh commented on code in PR #216: URL: https://github.com/apache/incubator-devlake-website/pull/216#discussion_r975405147
########## docs/DeveloperManuals/DBMigration.md: ########## @@ -16,10 +16,15 @@ Migration script describes how to do database migration. They implement the `Script` interface. When DevLake starts, scripts register themselves to the framework by invoking the `Register` function +The method `Up` contains the steps of migration. When you write a new migration script, +please pay attention to the fault tolerance and the side effect. If something goes wrong during the migration, Review Comment: I think we can use the term **Reentrancy** here https://en.wikipedia.org/wiki/Reentrancy_(computing)#:~:text=In%20computing%2C%20a%20computer%20program,%2Dentered%22)%20before%20its%20previous ########## docs/DeveloperManuals/DBMigration.md: ########## @@ -16,10 +16,15 @@ Migration script describes how to do database migration. They implement the `Script` interface. When DevLake starts, scripts register themselves to the framework by invoking the `Register` function +The method `Up` contains the steps of migration. When you write a new migration script, +please pay attention to the fault tolerance and the side effect. If something goes wrong during the migration, +it would be better if the failed script could be safely retry. For this purpose, the migration scripts should be well-designed. +For example, if you created a temporary table in the `Up` method, it should be dropped before exiting, regardless of success or failure. Review Comment: We should suggest the `defer` function. @mappjzc please add your code example here ########## docs/DeveloperManuals/Release-SOP.md: ########## @@ -98,7 +98,11 @@ https://incubator.apache.org/guides/releasemanagement.html ```shell svn mv https://dist.apache.org/repos/dist/dev/incubator/devlake/0.12.0-incubating-rc2 https://dist.apache.org/repos/dist/release/incubator/devlake/0.12.0-incubating -m "transfer packages for 0.12.0-incubating-rc2" ``` -- Wait until the directory 0.12.0-incubating in https://downloads.apache.org/incubator/devlake/ was created +- Wait until the directory `https://downloads.apache.org/incubator/devlake/0.12.0-incubating/` was created +- Remove the last release from `https://downloads.apache.org/` (according the Apache release policy, this link is to the current release) Review Comment: this link should be pointing to the current release ########## docs/DeveloperManuals/DBMigration.md: ########## @@ -16,10 +16,15 @@ Migration script describes how to do database migration. They implement the `Script` interface. When DevLake starts, scripts register themselves to the framework by invoking the `Register` function +The method `Up` contains the steps of migration. When you write a new migration script, +please pay attention to the fault tolerance and the side effect. If something goes wrong during the migration, +it would be better if the failed script could be safely retry. For this purpose, the migration scripts should be well-designed. Review Comment: it -> It, and remove the space before failed -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
