From 3dd4db2f2aa30e303d03847cea122612ac8d0280 Mon Sep 17 00:00:00 2001
From: Ramon <ramon.guimera@skyscanner.net>
Date: Tue, 21 Nov 2023 16:19:29 +0100
Subject: [PATCH] fix doc building, action versions and update readme

---
 .github/workflows/lint-and-test.yml   | 4 ++--
 .github/workflows/pypi-release.yml    | 4 ++--
 .github/workflows/test-docs.yml       | 6 +++---
 .readthedocs.yml => .readthedocs.yaml | 6 +++++-
 README.md                             | 8 +++++---
 5 files changed, 17 insertions(+), 11 deletions(-)
 rename .readthedocs.yml => .readthedocs.yaml (74%)

diff --git a/.github/workflows/lint-and-test.yml b/.github/workflows/lint-and-test.yml
index 8677fe47..2ad775c4 100644
--- a/.github/workflows/lint-and-test.yml
+++ b/.github/workflows/lint-and-test.yml
@@ -14,10 +14,10 @@ jobs:
     name: Python ${{ matrix.python-version }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Setup python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
diff --git a/.github/workflows/pypi-release.yml b/.github/workflows/pypi-release.yml
index e6730995..edb928e0 100644
--- a/.github/workflows/pypi-release.yml
+++ b/.github/workflows/pypi-release.yml
@@ -9,10 +9,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Setup python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: '3.7'
 
diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml
index d139947e..46e05d08 100644
--- a/.github/workflows/test-docs.yml
+++ b/.github/workflows/test-docs.yml
@@ -9,12 +9,12 @@ jobs:
     name: Test Docs
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Setup python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: 3.12
 
       - run: make install-docs
 
diff --git a/.readthedocs.yml b/.readthedocs.yaml
similarity index 74%
rename from .readthedocs.yml
rename to .readthedocs.yaml
index 69eb36d7..df6d16e2 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yaml
@@ -5,8 +5,12 @@ mkdocs:
 
 formats: all
 
+build:
+   os: ubuntu-22.04
+   tools:
+     python: "3.12"
+
 python:
-  version: 3.7
   install:
     - method: pip
       path: .
diff --git a/README.md b/README.md
index b5ee8d80..cb245163 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,8 @@
 
 ![Build Status](https://github.com/Skyscanner/pycfmodel/workflows/PyPI%20release/badge.svg)
 [![PyPI version](https://badge.fury.io/py/pycfmodel.svg)](https://badge.fury.io/py/pycfmodel)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/Skyscanner/pycfmodel.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Skyscanner/pycfmodel/alerts/)
-[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/Skyscanner/pycfmodel.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Skyscanner/pycfmodel/context:python)
 [![Documentation Status](https://readthedocs.org/projects/pycfmodel/badge/?version=latest)](https://pycfmodel.readthedocs.io/en/latest/?badge=latest)
+![License](https://img.shields.io/github/license/skyscanner/pycfmodel)
 
 *A python model for Cloud Formation scripts.*
 
@@ -16,6 +15,7 @@ inspecting CloudFormation scripts.
 `pip install pycfmodel`
 
 ## Currently Supported
+
 * AWSTemplateFormatVersion
 * Conditions
 * Description
@@ -54,6 +54,7 @@ inspecting CloudFormation scripts.
 * Transform
 
 ## Example
+
 ```python
 from pycfmodel import parse
 
@@ -114,7 +115,8 @@ make test
 make freeze
 ```
 
-If the test `tests/test_constants.py::test_cloudformation_actions` is failing, it can be resolved by updating the known AWS Actions:
+If the test `tests/test_constants.py::test_cloudformation_actions` is failing, it can be resolved by updating the known
+AWS Actions:
 
 ```bash
 python3 scripts/generate_cloudformation_actions_file.py