Merge pull request #364 from liquibase/DAT-14184

[DAT-14184] Add index.htm file to xsd schemes page
liquibase · May 15, 2023 · 1439b1e · 1439b1e
2 parents aa61108 + d64703c
commit 1439b1e
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 0 deletions.
diff --git a/.github/workflows/release-published.yml b/.github/workflows/release-published.yml
@@ -50,3 +50,24 @@ jobs:
           # aws s3 sync syncs directories and S3 prefixes.
           run: |
             aws s3 sync liquibase-mongodb/src/main/resources/www.liquibase.org/xml/ns/mongodb/ s3://liquibaseorg-origin/xml/ns/mongodb/ --content-type application/octet-stream --only-show-errors
+
+        - name: Index.htm file upload
+          env:
+            AWS_ACCESS_KEY_ID: ${{ secrets.LIQUIBASEORIGIN_ACCESS_KEY_ID }}
+            AWS_SECRET_ACCESS_KEY: ${{ secrets.LIQUIBASEORIGIN_SECRET_ACCESS_KEY }}
+            AWS_DEFAULT_REGION: us-east-1
+          # List all xsd and htm files in repository. Copy index.htm to temporary folder
+          # Add links for all xsd files to index.htm file (except liquibase-mongodb-latest.xsd and index.htm)
+          # Sync index.htm with the s3
+          run: |
+            search_dir=liquibase-mongodb/src/main/resources/www.liquibase.org/xml/ns/mongodb
+            filenames=`ls -1 $search_dir`
+            mkdir index-file
+            cp liquibase-mongodb/src/main/resources/www.liquibase.org/xml/ns/mongodb/index.htm index-file/
+            for entry in $filenames
+            do
+              if [[ "$entry" != "liquibase-mongodb-latest.xsd" ]] && [[ "$entry" != "index.htm" ]] ;then
+                sed -ie "s/<\/ul>/  <li><a href=\"\/xml\/ns\/mongodb\/${entry}\">${entry}<\/a><\/li>\n<\/ul>/" index-file/index.htm
+              fi
+            done
+            aws s3 sync index-file s3://liquibaseorg-origin/xml/ns/liquibase-mongodb/ --only-show-errors
diff --git a/src/main/resources/www.liquibase.org/xml/ns/mongodb/index.htm b/src/main/resources/www.liquibase.org/xml/ns/mongodb/index.htm
@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<!--[if lt IE 7]>      <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
+<!--[if IE 7]>         <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
+<!--[if IE 8]>         <html class="no-js lt-ie9"> <![endif]-->
+<!--[if gt IE 8]><!-->
+<html class="no-js">
+<!--<![endif]-->
+
+<head>
+    <meta charset="utf-8">
+    <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
+    <title>Liquibase | Liquibase XML Schema Definitions</title>
+    <meta name="description" content="Liquibase XML Schema Definitions">
+    <meta content="width=device-width" name="viewport">
+
+    <link href="http://www.liquibase.org/rss.xml" rel="alternate" title="Liquibase RSS Feed" type="application/rss+xml"/>
+
+
+
+    <!-- HTTP => HTTPS Client Side Redirect -->
+    <script>
+        if (location.protocol !== 'https:') {
+            location.replace('https:' + location.href.substring(location.protocol.length))
+        }
+    </script>
+
+
+
+    <h1>Liquibase Mongo extension XML Schema Definitions</h1>
+
+    <p>This page contains a list of all the Liquibase Mongo extension XSD files. A new version of the XSD is generally available for each change to the major or minor version of Liquibase Mongo extension scheme. XSD schemas are written in XML, and describe what a properly formed XML document for a particular application should look like. If you really want to get the lowdown, <a href="https://www.w3schools.com/xml/xml_namespaces.asp">this is a good article on XML and namespaces.</a></p>
+
+    <p>Simply put, referencing one of these XSD files in your <em>changelog</em> allows both Liquibase itself and any third-party XML tool (like an editor) to validate that your <em>changelog</em> is properly formed. There is more information about the format of XML changelog files <a href="https://docs.liquibase.com/concepts/tracking-tables/databasechangelog-table.html">in the databasechangelog page</a></p>
+
+    <p>These XSD files are embedded into the Liquibase Mongo extension jar file, and don’t normally need to be downloaded from this site, but these are here for easier reference.</p>
+
+    <ul>
+        <li><a href="/xml/ns/mongodb/mongodb-latest.xsd">liquibase-mongodb-latest.xsd</a></li>
+        <!-- Other links will be autogenerated by CI -->
+</ul>