Upmerge 2021 10 20

.github/SECURITY.md

@@ -12,8 +12,8 @@ At this time, with the latest release of v2.5.0, the supported
 versions are:
 
   - 1.14.2: Current LTS
-  - v2.4.0: Prior release
-  - v2.5.0: Current release
+  - v2.5.0: Prior release
+  - v2.6.0: Current release
 
 ## Reporting process
 

.github/workflows/compliance.yml

@@ -3,6 +3,22 @@ name: Compliance
 on: pull_request
 
 jobs:
+  maintainer_check:
+    runs-on: ubuntu-latest
+    name: Check MAINTAINERS file
+    steps:
+    - name: Checkout the code
+      uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+        fetch-depth: 0
+    - name: Run Maintainers Script
+      id: maintainer
+      env:
+        BASE_REF: ${{ github.base_ref }}
+      run: |
+        python3 ./scripts/get_maintainer.py path CMakeLists.txt
+
   compliance_job:
     runs-on: ubuntu-latest
     name: Run compliance checks on patch series (PR)

.github/workflows/devicetree_checks.yml

@@ -22,6 +22,9 @@ jobs:
       matrix:
         python-version: [3.6, 3.7, 3.8]
         os: [ubuntu-latest, macos-latest, windows-latest]
+        exclude:
+          - os: macos-latest
+            python-version: 3.6
     steps:
     - name: checkout
       uses: actions/checkout@v2

.github/workflows/doc-build.yml

@@ -1,9 +1,14 @@
 # Copyright (c) 2020 Linaro Limited.
 # SPDX-License-Identifier: Apache-2.0
 
-name: Documentation GitHub Workflow
+name: Documentation Build
 
 on:
+  schedule:
+    - cron: '0 */3 * * *'
+  push:
+    tags:
+      - v*
   pull_request:
     paths:
     - 'doc/**'
@@ -20,20 +25,18 @@ on:
     - 'scripts/requirements-doc.txt'
 
 env:
+  # NOTE: west docstrings will be extracted from the version listed here
+  WEST_VERSION: 0.11.1
   # The latest CMake available directly with apt is 3.18, but we need >=3.20
   # so we fetch that through pip.
   CMAKE_VERSION: 3.20.5
 
 jobs:
-  doc-build:
-    name: "Documentation Build"
+  doc-build-html:
+    name: "Documentation Build (HTML)"
     runs-on: ubuntu-latest
 
     steps:
-    - name: Update PATH for west
-      run: |
-        echo "$HOME/.local/bin" >> $GITHUB_PATH
-
     - name: checkout
       uses: actions/checkout@v2
 
@@ -45,27 +48,82 @@ jobs:
       uses: actions/cache@v1
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-doc-pip
+        key: pip-${{ hashFiles('scripts/requirements-doc.txt') }}
 
     - name: install-pip
       run: |
         sudo pip3 install -U setuptools wheel pip
         pip3 install -r scripts/requirements-doc.txt
-        pip3 install west==0.11.0
+        pip3 install west==${WEST_VERSION}
         pip3 install cmake==${CMAKE_VERSION}
 
     - name: west setup
       run: |
-        west init -l . || true
+        west init -l .
 
     - name: build-docs
       run: |
-        SPHINXOPTS="-q -W -j auto" make -C doc html
-        tar cvf htmldocs.tar --directory=./doc/_build html
+        if [[ "$GITHUB_REF" =~ "refs/tags/v" ]]; then
+          DOC_TAG="release"
+        else
+          DOC_TAG="development"
+        fi
+
+        DOC_TAG=${DOC_TAG} SPHINXOPTS="-q -W -j auto" make -C doc html
+
+    - name: compress-docs
+      run: |
+        tar cfJ html-output.tar.xz --directory=doc/_build html
+
+    - name: upload-build
+      uses: actions/upload-artifact@master
+      with:
+        name: html-output
+        path: html-output.tar.xz
+
+  doc-build-pdf:
+    name: "Documentation Build (PDF)"
+    runs-on: ubuntu-latest
+    container: texlive/texlive:latest
+
+    steps:
+    - name: checkout
+      uses: actions/checkout@v2
+
+    - name: install-pkgs
+      run: |
+        apt-get update
+        apt-get install -y python3-pip ninja-build doxygen graphviz librsvg2-bin
+
+    - name: cache-pip
+      uses: actions/cache@v1
+      with:
+        path: ~/.cache/pip
+        key: pip-${{ hashFiles('scripts/requirements-doc.txt') }}
+
+    - name: install-pip
+      run: |
+        pip3 install -U setuptools wheel pip
+        pip3 install -r scripts/requirements-doc.txt
+        pip3 install west==${WEST_VERSION}
+        pip3 install cmake==${CMAKE_VERSION}
+
+    - name: west setup
+      run: |
+        west init -l .
+
+    - name: build-docs
+      run: |
+        if [[ "$GITHUB_REF" =~ "refs/tags/v" ]]; then
+          DOC_TAG="release"
+        else
+          DOC_TAG="development"
+        fi
+
+        DOC_TAG=${DOC_TAG} SPHINXOPTS="-q -j auto" LATEXMKOPTS="-quiet -halt-on-error" make -C doc pdf
 
     - name: upload-build
       uses: actions/upload-artifact@master
-      continue-on-error: True
       with:
-        name: htmldocs.tar
-        path: htmldocs.tar
+        name: pdf-output
+        path: doc/_build/latex/zephyr.pdf

.github/workflows/doc-publish.yml

@@ -1,48 +1,35 @@
 # Copyright (c) 2020 Linaro Limited.
+# Copyright (c) 2021 Nordic Semiconductor ASA
 # SPDX-License-Identifier: Apache-2.0
 
-name: Doc build for Release or Daily
+name: Publish Documentation
 
-# Either a daily based on schedule/cron or only on tag push
 on:
-  schedule:
-    - cron:  '50 1/3 * * *'
-  push:
-    paths:
-      - 'VERSION'
+  workflow_run:
+    workflows: ["Documentation Build"]
+    branches:
+      - main
+      - v*
     tags:
-      # only publish v* tags, do not care about zephyr-v* which point to the
-      # same commit
-      - 'v*'
+      - v*
+    types:
+      - completed
 
 jobs:
   doc-publish:
     name: Publish Documentation
     runs-on: ubuntu-latest
-    if: github.repository == 'zephyrproject-rtos/zephyr'
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
 
     steps:
-    - name: Update PATH for west
-      run: |
-        echo "$HOME/.local/bin" >> $GITHUB_PATH
+    - name: Download artifacts
+      uses: dawidd6/action-download-artifact@v2
+      with:
+        workflow: doc-build.yml
 
-    - name: Determine tag
-      id: tag
+    - name: Uncompress HTML docs
       run: |
-        # We expect to get here either due to a schedule event in which
-        # case we are doing a daily build of the docs, or because a new
-        # tag was pushed, in which case we are building docs for a release
-        if [ ${GITHUB_EVENT_NAME} == "schedule" ]; then
-           echo ::set-output name=TYPE::daily;
-           echo ::set-output name=RELEASE::latest;
-        elif [ ${GITHUB_EVENT_NAME} == "push" ]; then
-           # If push due to a tag GITHUB_REF will look like refs/tags/TAG-FOO
-           # chop of 'refs/tags' so RELEASE=TAG-FOO
-           echo ::set-output name=TYPE::release;
-           echo ::set-output name=RELEASE::${GITHUB_REF/refs\/tags\//};
-        else
-           exit 1
-        fi
+        tar xf html-output/html-output.tar.xz -C html-output
 
     - name: Configure AWS Credentials
       uses: aws-actions/configure-aws-credentials@v1
@@ -51,59 +38,16 @@ jobs:
         aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
         aws-region: us-east-1
 
-    - name: checkout
-      uses: actions/checkout@v2
-
-    - name: install-pkgs
-      run: |
-        sudo apt-get install -y ninja-build doxygen graphviz
-
-    - name: cache-pip
-      uses: actions/cache@v1
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-doc-pip
-
-    - name: install-pip
-      run: |
-        sudo pip3 install -U setuptools wheel pip
-        pip3 install -r scripts/requirements-base.txt
-        pip3 install -r scripts/requirements-doc.txt
-
-    - name: west setup
-      run: |
-        west init -l . || true
-
-    - name: build-docs
-      env:
-        DOC_TAG: ${{ steps.tag.outputs.TYPE }}
-      run: |
-        source zephyr-env.sh
-        make DOC_TAG=${DOC_TAG} -C doc html
-
     - name: Upload to AWS S3
       env:
-        RELEASE: ${{ steps.tag.outputs.RELEASE }}
+        HEAD_BRANCH: ${{ github.event.workflow_run.head_branch }}
       run: |
-        echo "DOC_RELEASE=[$RELEASE]"
-        if [ "$RELEASE" == "latest" ]; then
-           echo "publish latest docs"
-           aws s3 sync  --quiet doc/_build/html s3://docs.zephyrproject.org/latest --delete
-           echo "success sync of latest docs"
+        if [ "${HEAD_BRANCH:0:1}" == "v" ]; then
+          VERSION=${HEAD_BRANCH:1}
         else
-           # we want just the version, without the leading 'v'
-           DOC_RELEASE=${RELEASE:1}
-           echo "publish release docs: ${DOC_RELEASE}"
-           aws s3 sync  --quiet doc/_build/html s3://docs.zephyrproject.org/${DOC_RELEASE}
-           echo "success sync of rel docs"
-        fi
-        if [ -d doc/_build/doxygen/html ]; then
-           if [ "$RELEASE" == "latest" ]; then
-              API_RELEASE=latest
-           else
-              API_RELEASE=${RELEASE:1}
-           fi
-           echo "publish doxygen to apidoc/${API_RELEASE}"
-           aws s3 sync  --quiet doc/_build/doxygen/html s3://docs.zephyrproject.org/apidoc/${API_RELEASE} --delete
-           echo "success publish of doxygen"
+          VERSION="latest"
         fi
+
+        aws s3 sync --quiet html-output/html s3://docs.zephyrproject.org/${VERSION} --delete
+        aws s3 sync --quiet html-output/html/doxygen/html s3://docs.zephyrproject.org/apidoc/${VERSION} --delete
+        aws s3 cp --quiet pdf-output/zephyr.pdf s3://docs.zephyrproject.org/${VERSION}/zephyr.pdf

.github/workflows/manifest.yml

@@ -17,7 +17,7 @@ jobs:
           fetch-depth: 0
 
       - name: Manifest
-        uses: zephyrproject-rtos/action-manifest@v1.1.0
+        uses: zephyrproject-rtos/action-manifest@2f1ad2908599d4fe747f886f9d733dd7eebae4ef
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           manifest-path: 'west.yml'

.github/workflows/west_cmds.yml

@@ -23,6 +23,9 @@ jobs:
       matrix:
         python-version: [3.6, 3.7, 3.8]
         os: [ubuntu-latest, macos-latest, windows-latest]
+        exclude:
+          - os: macos-latest
+            python-version: 3.6
     steps:
     - name: checkout
       uses: actions/checkout@v2