From 0a0e7c94c66d93709db39f4c8fda68b4b87859be Mon Sep 17 00:00:00 2001
From: Nicolas <25302138+NicolasCwy@users.noreply.github.com>
Date: Sat, 20 Apr 2024 10:09:18 +0800
Subject: [PATCH] [#12048] Update changelog docs and changelog name (#13062)

* Update docs

* Rename changelog file

* Amend changelog naming
---
 docs/schema-migration.md                                      | 4 ++--
 src/main/resources/db/changelog/db.changelog-root.xml         | 2 +-
 ...ngelog-v9.0.0beta.5.xml => db.changelog-v9.0.0-beta.5.xml} | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)
 rename src/main/resources/db/changelog/{db.changelog-v9.0.0beta.5.xml => db.changelog-v9.0.0-beta.5.xml} (97%)

diff --git a/docs/schema-migration.md b/docs/schema-migration.md
index 463f0cbb3c1..a681a7bc4ff 100644
--- a/docs/schema-migration.md
+++ b/docs/schema-migration.md
@@ -31,5 +31,5 @@ Here is a brief description of the activities defined for Liquibase
 5. Generate snapshot of database by running `./gradlew liquibaseSnapshot -PrunList=snapshot`, the snapshot will be output to `liquibase-snapshot.json`
 6. Checkout your branch and repeat steps 2 and 4 to generate the tables found on your branch
 7. Run `./gradlew liquibaseDiffChangeLog -PrunList=diffMain` to generate changeLog to resolve database schema differences
-8. Manually add a changeSet to tag the database using `release_number` (See the last changeset in v9.0.0 for reference).
-9. Include the new changelog file in `changelog-root.xml`.
+8. Manually add a changeSet to tag the database using `release_number`. The tag should be named `<release_number` e.g `v9.0.0-beta.1` (See the last changeset in v9.0.0 for reference).
+9. Include the new changelog file as the last entry in `changelog-root.xml` as this is the order which changelogs are executed! (See [liquibase include tag](https://docs.liquibase.com/change-types/include.html))
diff --git a/src/main/resources/db/changelog/db.changelog-root.xml b/src/main/resources/db/changelog/db.changelog-root.xml
index 4b13a967223..bdacf10c68d 100644
--- a/src/main/resources/db/changelog/db.changelog-root.xml
+++ b/src/main/resources/db/changelog/db.changelog-root.xml
@@ -5,5 +5,5 @@
     xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd
                         http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
     <include file="src/main/resources/db/changelog/db.changelog-v9.0.0.xml" />
-    <include file="src/main/resources/db/changelog/db.changelog-v9.0.0beta.5.xml" />
+    <include file="src/main/resources/db/changelog/db.changelog-v9.0.0-beta.5.xml" />
 </databaseChangeLog>
diff --git a/src/main/resources/db/changelog/db.changelog-v9.0.0beta.5.xml b/src/main/resources/db/changelog/db.changelog-v9.0.0-beta.5.xml
similarity index 97%
rename from src/main/resources/db/changelog/db.changelog-v9.0.0beta.5.xml
rename to src/main/resources/db/changelog/db.changelog-v9.0.0-beta.5.xml
index e0270bc4a14..14642683cb1 100644
--- a/src/main/resources/db/changelog/db.changelog-v9.0.0beta.5.xml
+++ b/src/main/resources/db/changelog/db.changelog-v9.0.0-beta.5.xml
@@ -32,6 +32,6 @@
         <dropUniqueConstraint constraintName="Unique name and institute" tableName="account_requests"/>
     </changeSet>
     <changeSet author="ziqing" id="1713527659740-5">
-        <tagDatabase tag="v9.0.0beta.5"/>
+        <tagDatabase tag="v9.0.0-beta.5"/>
     </changeSet>
 </databaseChangeLog>