Merge pull request #169 from LachlanMcKee/move-changelog-to-root

Moved whatsnew.md to root and renamed to CHANGELOG.md
badoo · Aug 14, 2022 · 01b1e16 · 01b1e16
2 parents 7e46d6c + f59f76d
commit 01b1e16
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 2 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -4,5 +4,5 @@
 
 ## Check list
 
-- [ ] I have updated `whatsnew.md` if required.
+- [ ] I have updated `CHANGELOG.md` if required.
 - [ ] I have updated documentation if required.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -78,3 +78,15 @@ jobs:
           path: |
             **/build/reports
             logcat.out
+
+  check-documentation:
+    name: Check documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - run: cp CHANGELOG.md documentation/changelog.md
+      - run: pip install mkdocs-material
+      - run: mkdocs build --strict
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -15,5 +15,6 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: '3.x'
+      - run: cp CHANGELOG.md documentation/changelog.md
       - run: pip install mkdocs-material
       - run: mkdocs gh-deploy --force
diff --git a/documentation/whatsnew.md → CHANGELOG.md b/documentation/whatsnew.md → CHANGELOG.md
diff --git a/documentation/.gitignore b/documentation/.gitignore
@@ -0,0 +1 @@
+changelog.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -44,7 +44,7 @@ docs_dir: documentation
 
 nav:
 - Overview: index.md
-- What's new: whatsnew.md
+- Changelog: changelog.md
 - Features:
   - Core concepts: features/coreconcepts.md
   - Your first and simplest feature: features/reducerfeature.md