Added Changelog page for components (#594)

Added Changelog page for components
cloudposse · Aug 30, 2023 · 9b369c9 · 9b369c9
1 parent 89007e2
commit 9b369c9
Show file tree

Hide file tree

Showing 26 changed files with 7,804 additions and 4,637 deletions.
diff --git a/.github/workflows/website-deploy-preview.yml b/.github/workflows/website-deploy-preview.yml
@@ -78,10 +78,6 @@ jobs:
         run: |
           ./scripts/render-docs-for-components.sh
 
-      - name: "Copy Upgrade Guide"
-        run: |
-          ./scripts/copy-upgrade-guide.sh
-
       - name: "Render Documentation for Terraform Modules"
         env:
           PUBLIC_REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}

diff --git a/.gitignore b/.gitignore
@@ -64,4 +64,5 @@ static/assets/refarch/**
 !content/reference-architecture/refarch.json
 !content/reference-architecture/sitemap.xml
 !content/components/library/aws/_category_.json
-!content/github-actions/library/actions/_category_.json
+!content/github-actions/library/actions/_category_.json
+changelog/*
diff --git a/content/components/library/upgrade-guide.md b/content/components/library/upgrade-guide.md
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -23,7 +23,7 @@ const config = {
         path: 'content/docs',
         routeBasePath: '/',
         sidebarPath: require.resolve('./sidebars-docs.js'),
-        editUrl: ({versionDocsDirPath, docPath, locale}) => {
+        editUrl: ({ versionDocsDirPath, docPath, locale }) => {
           return `https://github.com/cloudposse/docs/edit/master/content/docs/${docPath}`;
         }
       },
@@ -37,6 +37,26 @@ const config = {
         sidebarPath: require.resolve('./sidebars-components.js')
       },
     ],
+    [
+      require.resolve('./src/plugins/changelog/index.js'),
+      {
+        blogTitle: 'Components Changelog',
+        blogDescription: 'Stay informed about new features and breaking changes in every release',
+        blogSidebarCount: 'ALL',
+        blogSidebarTitle: 'Changelog',
+        routeBasePath: '/components/changelog',
+        showReadingTime: false,
+        postsPerPage: 20,
+        archiveBasePath: null,
+        authorsMapPath: 'authors.json',
+        feedOptions: {
+          type: 'all',
+          title: 'Cloud Posse Components Changelog',
+          description: 'Stay informed about new features and breaking changes in every release',
+          copyright: `Copyright © ${new Date().getFullYear()} Cloud Posse, LLC.`
+        },
+      },
+    ],
     [
       '@docusaurus/plugin-content-docs',
       {
@@ -117,11 +137,11 @@ const config = {
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
-      metadata: [{name: 'google-site-verification', content: process.env.GOOGLE_SITE_VERIFICATION_ID || 'preview-local'}],
+      metadata: [{ name: 'google-site-verification', content: process.env.GOOGLE_SITE_VERIFICATION_ID || 'preview-local' }],
       docs: {
         sidebar: {
-            hideable: true,
-            autoCollapseCategories: true
+          hideable: true,
+          autoCollapseCategories: true
         },
       },
       navbar: {
@@ -133,18 +153,18 @@ const config = {
         },
         items: [
           {
-              to: '/intro',
-              position: 'left',
-              label: 'Fundamentals',
-              activeBaseRegex:
-                'fundamentals/.*|' +
-                'tutorials/.*|' +
-                'howto/.*|' +
-                'how-to/.*|' +
-                'community/.*|' +
-                'glossary/.*|' +
-                'reference/.*|' +
-                '/intro/',
+            to: '/intro',
+            position: 'left',
+            label: 'Fundamentals',
+            activeBaseRegex:
+              'fundamentals/.*|' +
+              'tutorials/.*|' +
+              'howto/.*|' +
+              'how-to/.*|' +
+              'community/.*|' +
+              'glossary/.*|' +
+              'reference/.*|' +
+              '/intro/',
           },
           {
             type: 'dropdown',
@@ -153,28 +173,28 @@ const config = {
             to: '/fundamentals/building-blocks/',
             items: [
               {
-                  to: '/components/',
-                  label: 'Components',
+                to: '/components/',
+                label: 'Components',
               },
               {
-                  to: '/modules/',
-                  label: 'Modules',
+                to: '/modules/',
+                label: 'Modules',
               },
               {
-                  to: '/github-actions/',
-                  label: 'GitHub Actions',
+                to: '/github-actions/',
+                label: 'GitHub Actions',
               },
               {
-                  href: 'https://atmos.tools',
-                  label: 'Atmos',
+                href: 'https://atmos.tools',
+                label: 'Atmos',
               },
             ]
           },
           {
-              href: '/reference-architecture/',
-              position: 'left',
-              html: 'Reference Architecture',
-              target: '_self',
+            href: '/reference-architecture/',
+            position: 'left',
+            html: 'Reference Architecture',
+            target: '_self',
           },
           {
             type: 'dropdown',
@@ -198,8 +218,8 @@ const config = {
                 href: 'https://archive.sweetops.com/refarch/',
               },
               {
-                  label: 'Office Hours',
-                  href: 'https://cloudposse.com/office-hours/',
+                label: 'Office Hours',
+                href: 'https://cloudposse.com/office-hours/',
               },
             ],
           },
@@ -230,65 +250,65 @@ const config = {
       footer: {
         style: 'dark',
         links: [{
-                title: 'Docs',
-                items: [{
-                    label: 'Getting Started',
-                    to: '/intro/',
-                }, {
-                    label: 'Building Blocks',
-                    to: '/fundamentals/building-blocks/',
-                }, {
-                    label: 'Tutorials',
-                    to: '/category/tutorials/',
-                }, {
-                    label: 'How-To',
-                    to: '/category/how-to/',
-                }],
-            }, {
-              title: 'Community',
-              items: [
-                {
-                  label: 'Github Discussions',
-                  href: 'https://ask.sweetops.com/',
-                },
-                {
-                  label: 'Community',
-                  href: 'https://sweetops.com/',
-                },
-                {
-                  label: 'Slack',
-                  href: 'https://slack.sweetops.com/',
-                },
-                {
-                  label: 'Slack Archives',
-                  href: 'https://archive.sweetops.com/refarch/',
-                },
-                {
-                    label: 'Office Hours',
-                    href: 'https://cloudposse.com/office-hours/',
-                },
-              ],
-            }, {
-                title: 'Contact Us',
-                items: [
-                {
-                  label: 'Support',
-                  href: 'https://cloudposse.com/accelerate',
-                },
-                {
-                  label: 'Our GitHub',
-                  href: 'https://github.com/cloudposse/',
-                },
-                {
-                  label: 'Contact Us',
-                  to: '/contact-us/',
-                }],
-            }],
-            logo: {
-                alt: 'Cloud Posse',
-                src: '/img/logo-light.svg',
-                href: 'https://cloudposse.com/'
+          title: 'Docs',
+          items: [{
+            label: 'Getting Started',
+            to: '/intro/',
+          }, {
+            label: 'Building Blocks',
+            to: '/fundamentals/building-blocks/',
+          }, {
+            label: 'Tutorials',
+            to: '/category/tutorials/',
+          }, {
+            label: 'How-To',
+            to: '/category/how-to/',
+          }],
+        }, {
+          title: 'Community',
+          items: [
+            {
+              label: 'Github Discussions',
+              href: 'https://ask.sweetops.com/',
             },
+            {
+              label: 'Community',
+              href: 'https://sweetops.com/',
+            },
+            {
+              label: 'Slack',
+              href: 'https://slack.sweetops.com/',
+            },
+            {
+              label: 'Slack Archives',
+              href: 'https://archive.sweetops.com/refarch/',
+            },
+            {
+              label: 'Office Hours',
+              href: 'https://cloudposse.com/office-hours/',
+            },
+          ],
+        }, {
+          title: 'Contact Us',
+          items: [
+            {
+              label: 'Support',
+              href: 'https://cloudposse.com/accelerate',
+            },
+            {
+              label: 'Our GitHub',
+              href: 'https://github.com/cloudposse/',
+            },
+            {
+              label: 'Contact Us',
+              to: '/contact-us/',
+            }],
+        }],
+        logo: {
+          alt: 'Cloud Posse',
+          src: '/img/logo-light.svg',
+          href: 'https://cloudposse.com/'
+        },
         copyright: `© ${new Date().getFullYear()} Cloud Posse, LLC`,
       },
       prism: {