Merge pull request #11 from NHSLeadership/develop

GitHub actions improvement

.github/workflows/release.yml

@@ -11,11 +11,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           persist-credentials: false
 
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v3
         with:
           node-version: 19
           registry-url: https://registry.npmjs.org
@@ -32,22 +32,12 @@ jobs:
 
       - name: Create release
         id: create_release
-        uses: actions/create-release@v1
+        uses: softprops/action-gh-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
+          files: ${{ steps.get_version.outputs.VERSION }}.zip
           tag_name: ${{ github.ref }}
-          release_name: ${{ github.ref }}
+          name: ${{ github.ref }}
           draft: false
           prerelease: false
-
-      - name: Upload release asset
-        id: upload-release-asset
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: ${{ steps.get_version.outputs.VERSION }}.zip
-          asset_name: ${{ steps.get_version.outputs.VERSION }}.zip
-          asset_content_type: application/zip

README.md

@@ -1,11 +1,10 @@
 ## NHSE Moodle theme (Boost extension)
-### Latest version v1.0
-
-Requirements
+### Requirements
 1. Node 19.4
 2. Moodle 4.1 with Boost theme
 
-Installation 
+### Installation 
+
 1. Clone that repository into your Moodle `theme/nhse` directory.
 ```
 git clone [email protected]:NHSLeadership/moodle-nhse.git nhse
@@ -24,3 +23,17 @@ node -v
 3. Proceed with Moodle installer instructions when new theme is detected 
 
 4. If you need to change any dependencies of the SCSS files please remember to clear Moodle caches in Moodle admin panel `/admin/purgecaches.php`. Moodle SCSS compiler will do the rest for you.
+
+### Creating a new GitHub Release
+
+1. Update version.php
+
+2. Update composer.json
+
+3. Merge from develop to main
+
+4. `git checkout main && git pull`
+
+5. `git tag YYYYMMDDXX && git push --tags` (Moodle format where YYYYMMDD is the current date and XX is the release number, e.g. 2023042301 for the first release on 23rd April 2023)
+
+6. Allow GitHub Actions to complete.