Merge branch 'production' into development

Public-Health-Scotland · Sep 9, 2024 · e842787 · e842787
2 parents d357eb2 + 995634c
commit e842787
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 5 deletions.
diff --git a/.github/workflows/document.yaml b/.github/workflows/document.yaml
@@ -34,7 +34,7 @@ jobs:
 
       - name: Commit and create a Pull Request on development
         if: ${{ github.ref == 'refs/heads/development' }}
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@v7
         with:
           commit-message: "Update documentation"
           branch: document_development

diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -41,7 +41,7 @@ jobs:
 
       - name: Deploy to GitHub pages 🚀
         if: github.event_name != 'pull_request'
-        uses: JamesIves/github-pages-deploy-action@v4.6.3
+        uses: JamesIves/github-pages-deploy-action@v4.6.4
         with:
           clean: false
           branch: gh-pages

diff --git a/.github/workflows/render-README.yaml b/.github/workflows/render-README.yaml
@@ -35,7 +35,7 @@ jobs:
 
       - name: Commit and create a Pull Request on production
         if: ${{ github.ref == 'refs/heads/production' }}
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@v7
         with:
           commit-message: "Render `README.md` after changes to the `.Rmd` version"
           branch: render_readme

diff --git a/.github/workflows/style.yaml b/.github/workflows/style.yaml
@@ -60,7 +60,7 @@ jobs:
 
       - name: Commit and create a Pull Request on development
         if: ${{ github.ref == 'refs/heads/development' }}
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@v7
         with:
           commit-message: "Style package"
           branch: document_development

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Type: Package
 Package: slfhelper
 Title: Useful functions for working with the Source Linkage Files
-Version: 0.10.2
+Version: 0.10.3
 Authors@R: c(
     person("Public Health Scotland", , , "phs.source@phs.scot", role = "cph"),
     person("James", "McMahon", , "james.mcmahon@phs.scot", role = c("aut"),

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,5 @@
+# slfhelper 0.10.3
+
 # slfhelper 0.10.2
 
 # slfhelper 0.10.1

diff --git a/README.md b/README.md
@@ -41,6 +41,23 @@ install.packages("pak")
 pak::pak("Public-Health-Scotland/slfhelper")
 ```
 
+## Additional Documentation 
+
+### SLFhelper Articles
+
+We have created some additional documentation to help with using
+SLFhelper. The new documentation can be found here: https://public-health-scotland.github.io/slfhelper/
+by selecting the drop down for Articles. 
+
+This includes: 
+* Memory usage when using SLFs in Posit
+* Using the arrow package with SLFs
+* Example questions which have been answered using the SLFs (full code available)
+
+If you find this useful and would like to see other topics included in
+future documentation, please get in touch with the team. 
+
+
 ## Usage
 
 ### Read a file