Merge branch 'main' of https://github.com/ArmDeveloperEcosystem/arm-learning-paths

Author: GayathriNarayana19

.devcontainer/Dockerfile

@@ -1,15 +1,15 @@
-FROM ubuntu:latest
+FROM ubuntu:22.04
 
 ARG TARGETPLATFORM
 
 RUN apt-get update && \
     apt-get -y install vim wget sudo git 
 
 RUN case ${TARGETPLATFORM} in \
-         "linux/amd64")  HUGO=hugo_0.111.2_linux-amd64 ;; \
-         "linux/arm64")  HUGO=hugo_0.111.2_linux-arm64 ;; \
+         "linux/amd64")  HUGO=hugo_0.130.0_linux-amd64 ;; \
+         "linux/arm64")  HUGO=hugo_0.130.0_linux-arm64 ;; \
     esac \
-    && HUGO_VER=v0.111.2 \
+    && HUGO_VER=v0.130.0 \
     &&  wget https://github.com/gohugoio/hugo/releases/download/${HUGO_VER}/${HUGO}.deb && apt-get -y install ./${HUGO}.deb
 
 # User account

.devcontainer/devcontainer.json

@@ -7,6 +7,6 @@
 
     "remoteUser": "ubuntu",
 
-    "postStartCommand": "nohup bash -c 'hugo ; bin/pagefind --site public --output-subdir ../static/pagefind ; hugo server --baseUrl=/ --liveReloadPort=443 --appendPort=false --bind=0.0.0.0 &' "
+    "postStartCommand": "nohup bash -c 'hugo ; bin/pagefind --site public --output-subdir ../static/pagefind ; hugo server --baseURL=/ --liveReloadPort=443 --appendPort=false --bind=0.0.0.0 &' "
 
 }

.github/pull_request_template.md

@@ -2,7 +2,7 @@
 Before submitting a pull request for a new Learning Path, please review [Create a Learning Path](https://learn.arm.com//learning-paths/cross-platform/_example-learning-path/)
 - [ ] I have reviewed Create a Learning Path
 
-Please do not include any confidential information in your contribution. This includes confidential microarchitecture details and unannounced product information. No AI tool can be used to generate either content or code when creating a learning path or install guide.
+Please do not include any confidential information in your contribution. This includes confidential microarchitecture details and unannounced product information. 
 
 - [ ] I have checked my contribution for confidential information
 

.github/workflows/content-checks.yml

@@ -14,15 +14,15 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: true
           fetch-depth: 0
 
       - name: Setup Hugo
-        uses: peaceiris/actions-hugo@v2
+        uses: peaceiris/actions-hugo@v3
         with:
-          hugo-version: '0.98.0'
+          hugo-version: '0.130.0'
           extended: true
 
       - name: Build
@@ -35,50 +35,57 @@ jobs:
         run: bin/htmltest -c .htmltest.yml -s 2>&1 | tee htmltest.log
 
       - name: HTML test results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: htmltest-report
           path: htmltest.log
-          retention-days: 7 # Default is 90 days
+          retention-days: 5 # Default is 90 days
 
       - name: Spell check
-        uses: rojopolis/[email protected]
+        continue-on-error: true
+        uses: rojopolis/[email protected]
         with:
           config_path: .spellcheck.yml
           task_name: Markdown
           output_file: spellcheck-output.txt
 
+      - name: Refine spelling results
+        continue-on-error: true
+        run: tools/process-spelling.sh
+
       - name: Spelling results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: spellcheck-output
           path: spellcheck-output.txt
-          retention-days: 7 # Default is 90 days
+          retention-days: 5 # Default is 90 days
 
       - name: Scan for malware
         run: |
           tools/install-scan.sh
           clamscan -r -i public -l scanlog
 
       - name: Scan results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: clamscan-log
           path: scanlog
-          retention-days: 7 # Default is 90 days
+          retention-days: 5 # Default is 90 days
 
       - name: Azure DevOps Security Scan
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
           dotnet-version: |
             5.0.x
             6.0.x
       - name: Run Microsoft Security DevOps
-        uses: microsoft/security-devops-action@preview
+        uses: microsoft/security-devops-action@latest
         id: msdo
+        with:
+          tools: container-mapping, bandit, eslint, templateanalyzer
 
       - name: Upload results to Security tab
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: ${{ steps.msdo.outputs.sarifFile }}
-          retention-days: 7 # Default is 90 days
+          retention-days: 5 # Default is 90 days

.github/workflows/deploy.yml

@@ -1,67 +1,81 @@
-# This is a basic workflow to help you get started with Actions
+name: Deploy Hugo to S3
 
-name: content-deploy
-
-# Controls when the workflow will run
 on:
- # Triggers the workflow on push to production branch
-  push:
-    branches: [ production ]
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
+  workflow_call:
+    inputs:
+      target:
+        description: "Hugo target to deploy to"
+        required: true
+        type: string
+      aws-region:
+        description: "AWS Region to use for fetching credentials"
+        required: false
+        type: string
+        default: "us-west-2"
+    secrets:
+      AWS_OIDC_ROLE:
+        required: true
+      HUGO_LLM_API:
+        required: true
+      HUGO_RAG_API:
+        required: true
+      HUGO_AUDIO_API:
+        required: true
+      HUGO_DEV_PROG_SIGNIUP_FORM_MUNCHKIN_ID:
+        required: true
+      HUGO_FORM_ID_FOR_PROGRAM_SIGNUP:
+        required: true
+
+env:
+  HUGO_VERSION: 0.130.0
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
   build_and_deploy:
     # The type of runner that the job will run on
-    runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
+    runs-on: ubuntu-24.04-arm
+    permissions:
+      id-token: write
+      contents: read
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v3
+      # Checks-out the repository under $GITHUB_WORKSPACE, so the job can access it
+      - uses: actions/checkout@v4
         with:
-          submodules: true  # Fetch Hugo Themes
-          fetch-depth: 0 
+          submodules: true # Fetch Hugo Themes
+          fetch-depth: 0
 
       # Sets Up Hugo
       - name: Setup Hugo
-        uses: peaceiris/actions-hugo@v2
+        uses: peaceiris/actions-hugo@v3
         with:
-            hugo-version: '0.98.0'
-            extended: true
-            
-      # Post-CSS install
+          hugo-version: ${{ env.HUGO_VERSION }}
+          extended: true
+          
+      - name: Clear npm cache
+        run: npm cache clean --force
+          
+      # Installs Post-CSS
       - name: Install Post-CSS
         run: npm install postcss-cli
 
-      # Builds arm-learning-paths repo
+      - name: AWS Github OIDC Login
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: ${{ secrets.AWS_OIDC_ROLE }}
+          aws-region: ${{ inputs.aws-region }}
+
+      # Builds arm-software-developer repo
       - name: Build
         run: |
           hugo --minify
           cp learn-image-sitemap.xml public/learn-image-sitemap.xml
-          bin/pagefind --site "public"
-        
-      #  Copy SSH Key
-      - name: copy key
-        run: |
-            echo $SSH_KEY | xargs -n 1 > tmpkey
-            base64 -d < tmpkey > key
-            chmod 400 key
-        shell: bash
-        env:
-          SSH_KEY: ${{secrets.SSH_KEY}}
-          
-      # SCP Site contents to netstorage
-      - name: copy site content
-        run: |
-          cd public
-          zip -r public.zip .
-          cd ..
-          scp -i key -o StrictHostKeyChecking=accept-new -oHostKeyAlgorithms=+ssh-dss -r public/public.zip $USR@$HOST:/$ID/
-        shell: bash
+          bin/pagefind.aarch64 --site "public"
         env:
-          USR: ${{secrets.SSH_USERNAME}}
-          HOST: ${{secrets.SSH_HOST}}
-          ID: ${{secrets.ID}}
+          HUGO_LLM_API: ${{ secrets.HUGO_LLM_API }}
+          HUGO_RAG_API: ${{ secrets.HUGO_RAG_API }}
+          HUGO_AUDIO_API: ${{ secrets.HUGO_AUDIO_API }}
+          HUGO_DEV_PROG_SIGNIUP_FORM_MUNCHKIN_ID: ${{ secrets.HUGO_DEV_PROG_SIGNIUP_FORM_MUNCHKIN_ID }}
+          HUGO_FORM_ID_FOR_PROGRAM_SIGNUP: ${{ secrets.HUGO_FORM_ID_FOR_PROGRAM_SIGNUP }}
+
+      # Deploys website to AWS S3 and invalidate CloudFront Cache
+      - name: Deploy to S3
+        run: hugo deploy --force --maxDeletes -1 --invalidateCDN --target ${{ inputs.target }}

.github/workflows/external-links.yml

@@ -17,7 +17,7 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: true
           fetch-depth: 0
@@ -33,7 +33,7 @@ jobs:
           pip install linkchecker 
           linkchecker --no-robots --config .linkcheckerrc --check-extern https://learn.arm.com/learning-paths/laptops-and-desktops/
           linkchecker --no-robots --config .linkcheckerrc --check-extern https://learn.arm.com/learning-paths/servers-and-cloud-computing/
-          linkchecker --no-robots --config .linkcheckerrc --check-extern https://learn.arm.com/learning-paths/smartphones-and-mobile/
-          linkchecker --no-robots --config .linkcheckerrc --check-extern https://learn.arm.com/learning-paths/embedded-systems/
-          linkchecker --no-robots --config .linkcheckerrc --check-extern https://learn.arm.com/learning-paths/microcontrollers/
-
+          linkchecker --no-robots --config .linkcheckerrc --check-extern https://learn.arm.com/learning-paths/mobile-graphics-and-gaming/
+          linkchecker --no-robots --config .linkcheckerrc --check-extern https://learn.arm.com/learning-paths/embedded-and-microcontrollers/
+          linkchecker --no-robots --config .linkcheckerrc --check-extern https://learn.arm.com/learning-paths/iot/
+          linkchecker --no-robots --config .linkcheckerrc --check-extern https://learn.arm.com/learning-paths/automotive/

.github/workflows/main.yml

@@ -1,53 +1,28 @@
-# This is a basic workflow to help you get started with Actions
+# This workflow will be triggered on a push to the 'main' branch automatically or when called manually.
+# Upon running this workflow, the website will be built and deployed to the internal instance.
+name: Build and Deploy Internal Website
 
-name: build-and-deploy
-
-# Controls when the workflow will run
 on:
-  # Triggers the workflow on push or pull request events but only for the master branch
+  # Runs on pushes to the 'main' branch
   push:
-    branches: [ main ]
+    branches: [main]
 
-  # Allows you to run this workflow manually from the Actions tab
+  # Allows to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
-  build_and_deploy_s3:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
-    steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v3
-        with:
-          submodules: true  # Fetch Hugo Themes
-          fetch-depth: 0 
-
-      # Sets Up Hugo
-      - name: Setup Hugo
-        uses: peaceiris/actions-hugo@v2
-        with:
-            hugo-version: '0.98.0'
-            extended: true
-            
-      # Post-CSS install
-      - name: Install Post-CSS
-        run: npm install postcss-cli
-
-      # Builds arm-software-developer repo
-      - name: Build
-        run: |
-          hugo --minify
-          cp learn-image-sitemap.xml public/learn-image-sitemap.xml
-          bin/pagefind --site "public"
-
-      # Deploys website to AWS S3
-      - name: Deploy to S3
-        run: hugo deploy --force --maxDeletes -1 --invalidateCDN
-        env:
-         AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          
+  build_and_deploy_internal:
+    name: Build and Deploy Internal
+    uses: ./.github/workflows/deploy.yml
+    permissions:
+      id-token: write
+      contents: read
+    with:
+      target: internal
+    secrets:
+      AWS_OIDC_ROLE: ${{ secrets.AWS_OIDC_ROLE_INTERNAL }}
+      HUGO_LLM_API: ${{ secrets.HUGO_LLM_API }}
+      HUGO_RAG_API: ${{ secrets.HUGO_RAG_API }}
+      HUGO_AUDIO_API: ${{ secrets.HUGO_AUDIO_API }}
+      HUGO_DEV_PROG_SIGNIUP_FORM_MUNCHKIN_ID: ${{ secrets.HUGO_DEV_PROG_SIGNIUP_FORM_MUNCHKIN_ID }}
+      HUGO_FORM_ID_FOR_PROGRAM_SIGNUP: ${{ secrets.HUGO_FORM_ID_FOR_PROGRAM_SIGNUP }}

.github/workflows/maintenance.yml

@@ -21,7 +21,7 @@ jobs:
     steps:
       # Check out repo and the whole history
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -33,7 +33,7 @@ jobs:
 
       # Upload report as artifact
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: outdated
           path: outdated_files.csv
@@ -49,11 +49,11 @@ jobs:
     steps:
       # Check out repo
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Download list of outdated files to test
       - name: Download a single artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: outdated
 
@@ -81,7 +81,7 @@ jobs:
            
       # Upload test reports as artifact
       - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: results
           path: junit-reports/*_cmd.xml