[v1.0.17] Migrate changelog (#44)

README.md

@@ -30,6 +30,6 @@ Current tasks are available on this [GitHub list of projects](https://github.com
     - MINOR version when you add functionality in a backwards compatible manner, and
     - PATCH version when you make backwards compatible bug fixes.
   - make sure `DEBUG_MODE` from `src/constants/general.ts` file is `false`
-  - make sure that `doc/guide/en/Changelog.md` and `doc/guide/fr/Changelog.md` are updated with a section describing the new version
 - Confirm that test suite passes with `npm run test`
 - Then run `npm run deploy`
+- Finally create a new release for this version on [GitHub Releases page](https://github.com/sebranly/ctr-ocr/releases) by adding the changelog

doc/guide/en/FAQ.md

@@ -56,4 +56,4 @@ Please see [CPUs](./CPUs.md)
 
 ## Tell me more about the changelog for this website
 
-Please see [Changelog](./Changelog.md)
+Please see [Changelog](https://github.com/sebranly/ctr-ocr/releases)

doc/guide/fr/FAQ.md

@@ -56,4 +56,4 @@ Veuillez consulter [CPUs](./CPUs.md)
 
 ## Dites-moi en plus à propos du changelog de ce site web
 
-Veuillez consulter [Changelog](./Changelog.md)
+Veuillez consulter [Changelog](https://github.com/sebranly/ctr-ocr/releases)

src/components/Footer.tsx

@@ -1,35 +1,31 @@
 import * as React from 'react';
-import { CRASH_TEAM_RANKING_AUTHOR_URL, GUIDE_FOLDER, PROJECT_URL, WEBSITE_VERSION } from '../constants/general';
+import { CRASH_TEAM_RANKING_AUTHOR_URL, CHANGELOG_URL, PROJECT_URL, WEBSITE_VERSION } from '../constants/general';
 
-const Footer = () => {
-  const guideChangelog = `${GUIDE_FOLDER}Changelog.md`;
-
-  return (
-    <>
-      <div className="mt2 text-center">
-        Developed by{' '}
-        <a href={PROJECT_URL} rel="noopener noreferrer" title="GitHub page for repository" target="_blank">
-          sebranly
-        </a>{' '}
-        (PSN:{' '}
-        <a
-          href={CRASH_TEAM_RANKING_AUTHOR_URL}
-          rel="noopener noreferrer"
-          title="Crash Team Ranking for ZouGui28"
-          target="_blank"
-        >
-          ZouGui28
-        </a>
-        ) with ❤️
-      </div>
-      <div className="mt2 text-center">
-        Website version{' '}
-        <a href={guideChangelog} rel="noopener noreferrer" title="Website changelog" target="_blank">
-          {WEBSITE_VERSION}
-        </a>
-      </div>
-    </>
-  );
-};
+const Footer = () => (
+  <>
+    <div className="mt2 text-center">
+      Developed by{' '}
+      <a href={PROJECT_URL} rel="noopener noreferrer" title="GitHub page for repository" target="_blank">
+        sebranly
+      </a>{' '}
+      (PSN:{' '}
+      <a
+        href={CRASH_TEAM_RANKING_AUTHOR_URL}
+        rel="noopener noreferrer"
+        title="Crash Team Ranking for ZouGui28"
+        target="_blank"
+      >
+        ZouGui28
+      </a>
+      ) with ❤️
+    </div>
+    <div className="mt2 text-center">
+      Website version{' '}
+      <a href={CHANGELOG_URL} rel="noopener noreferrer" title="Website changelog" target="_blank">
+        {WEBSITE_VERSION}
+      </a>
+    </div>
+  </>
+);
 
 export { Footer };

src/components/__test__/__snapshots__/Footer.test.tsx.snap

@@ -34,12 +34,12 @@ NodeList [
     Website version
      
     <a
-      href="https://github.com/sebranly/ctr-ocr/blob/main/doc/guide/en/Changelog.md"
+      href="https://github.com/sebranly/ctr-ocr/releases"
       rel="noopener noreferrer"
       target="_blank"
       title="Website changelog"
     >
-      1.0.16
+      1.0.17
     </a>
   </div>,
 ]

src/constants/general.ts

@@ -8,9 +8,10 @@ export const CRASH_TEAM_RANKING_AUTHOR_URL = 'https://crashteamranking.com/membe
 export const GUIDE_FOLDER = `${PROJECT_URL}/blob/main/doc/guide/${WEBSITE_LANGUAGE}/`;
 export const DEBUG_MODE = false;
 export const WEBSITE_TITLE = 'Crash Team Results';
-export const WEBSITE_VERSION = '1.0.16';
+export const WEBSITE_VERSION = '1.0.17';
 export const WEBSITE_DEFAULT_LANGUAGE = 'en';
 export const URL_CPUS = `${AUTHOR_GITHUB}/json/${JSON_FOLDER}/players.json`;
 export const EXAMPLE_IMAGES_FOLDER = `https://raw.githubusercontent.com/${AUTHOR_NAME}/${PROJECT_NAME}/main/src/img/examples/`;
 export const EXAMPLE_IMAGES_FOLDER_FULL_EVENT = `${PROJECT_URL}/tree/main/src/img/examples/full-event/`;
+export const CHANGELOG_URL = `${PROJECT_URL}/releases`;
 export const VIDEO_TUTORIAL = 'https://youtu.be/XjwoKGtEQag';