Several fixes and updates (#116)

* fix doc building, action versions and update readme * update changelog and version * copying cfripper update * update cloudformation_actions.py * revert test docs to 3.9 --------- Co-authored-by: Ramon <[email protected]>
Skyscanner · Nov 21, 2023 · cf9c45d · cf9c45d
1 parent 32262eb
commit cf9c45d
Show file tree

Hide file tree

Showing 9 changed files with 260 additions and 12 deletions.
diff --git 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
@@ -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
@@ -9,10 +9,10 @@ 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
 

diff --git a/.readthedocs.yml → .readthedocs.yaml b/.readthedocs.yml → .readthedocs.yaml
@@ -5,8 +5,12 @@ mkdocs:
 
 formats: all
 
+build:
+   os: ubuntu-22.04
+   tools:
+     python: "3.7"
+
 python:
-  version: 3.7
   install:
     - method: pip
       path: .

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,14 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## 0.21.1
+### Fixes
+- Documentation building.
+### Updates
+- Update `CLOUDFORMATION_ACTIONS`.
+- Actions versions.
+- ReadMe badges.
+
 ## 0.21.0
 ### Fixes
 - Fix resolving conditions recursively [#114](https://github.com/Skyscanner/pycfmodel/pull/114)

diff --git 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