forked from ARM-software/CMSIS-View
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Restructuring documentation - Update documentation version dropdown - Move doxygen revision history to generated file - Fix broken hyperlinks - Rework gen_pack.sh to gen-pack library
- Loading branch information
1 parent
8c6f7c8
commit 4bd92d7
Showing
96 changed files
with
810 additions
and
184 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "problemMatcher": [ | ||
| { | ||
| "owner": "doxygen", | ||
| "severity": "warning", | ||
| "pattern": [ | ||
| { | ||
| "regexp": "^(.*):(\\d+): warning: (.*)$", | ||
| "file": 1, | ||
| "line": 2, | ||
| "message": 3 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "problemMatcher": [ | ||
| { | ||
| "owner": "linkchecker", | ||
| "severity": "warning", | ||
| "pattern": [ | ||
| { | ||
| "regexp": "^(.*):(\\d+):(\\d+);(.*);(.*);(.*)$", | ||
| "file": 1, | ||
| "line": 2, | ||
| "column": 3, | ||
| "code": 5, | ||
| "message": 6 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| { | ||
| "problemMatcher": [ | ||
| { | ||
| "owner": "packchk", | ||
| "severity": "warning", | ||
| "pattern": [ | ||
| { | ||
| "regexp": "^\\*\\*\\* (INFO|WARNING) M(\\d+): (.*) \\(Line (\\d+)\\)$", | ||
| "file": 3, | ||
| "line": 4, | ||
| "code": 2 | ||
| }, | ||
| { | ||
| "regexp": "^ (.*)$", | ||
| "message": 1 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| name: Build documentation and pack | ||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| branches: [ main ] | ||
| pull_request: | ||
| branches: [ main ] | ||
| release: | ||
| types: [published] | ||
| jobs: | ||
| pack: | ||
| name: Generate pack | ||
| runs-on: ubuntu-20.04 | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Fetch tags | ||
| if: ${{ github.event_name == 'release' }} | ||
| run: | | ||
| git fetch --tags --force | ||
| - name: Install packages | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install --no-install-recommends -y libclang1-9 libclang-cpp1-9 p7zip libxml2-utils | ||
| sudo pip install LinkChecker | ||
| - name: Install doxygen 1.9.2 | ||
| run: | | ||
| wget https://doxygen.nl/files/doxygen-1.9.2.linux.bin.tar.gz | ||
| sudo tar -C /opt -xf doxygen-1.9.2.linux.bin.tar.gz | ||
| sudo ln -s /opt/doxygen-1.9.2/bin/doxygen /usr/local/bin/ | ||
| which doxygen | ||
| doxygen --version | ||
| - name: Install PackChk 1.3.95 | ||
| run: | | ||
| wget https://github.com/Open-CMSIS-Pack/devtools/releases/download/tools%2Fpackchk%2F1.3.95/packchk-1.3.95-linux64.zip | ||
| unzip packchk-1.3.95-linux64.zip | ||
| sudo mv packchk /usr/local/bin | ||
| which packchk | ||
| packchk --version | ||
| - name: Generate doxygen | ||
| run: | | ||
| echo "::add-matcher::.github/doxygen.json" | ||
| ./gen_doc.sh | ||
| echo "::remove-matcher owner=doxygen::" | ||
| working-directory: ./Doxygen | ||
|
|
||
| - name: Run linkchecker | ||
| run: | | ||
| echo "::add-matcher::.github/linkchecker.json" | ||
| ../Scripts/check_links.sh ./html/index.html ../Doxygen | ||
| echo "::remove-matcher owner=linkchecker::" | ||
| working-directory: ./Documentation | ||
|
|
||
| - name: Archive documentation | ||
| if: ${{ github.event_name == 'pull_request' }} | ||
| uses: actions/upload-artifact@v2 | ||
| with: | ||
| name: documentation | ||
| path: Documentation/html/ | ||
| retention-days: 1 | ||
| if-no-files-found: error | ||
|
|
||
| - name: Archive documentation | ||
| if: ${{ github.event_name == 'release' || github.event_name == 'push' || github.event_name == 'workflow_dispatch' }} | ||
| run: | | ||
| cd Documentation/html | ||
| tar -cvjf /tmp/doc.tbz2 . | ||
| - name: Generate pack | ||
| id: pack | ||
| run: | | ||
| mkdir -p ~/.arm/Packs/.Web | ||
| wget -O ~/.arm/Packs/.Web/ARM.CMSIS.pdsc https://www.keil.com/pack/ARM.CMSIS.pdsc | ||
| echo "::add-matcher::.github/packchk.json" | ||
| ./gen_pack.sh | ||
| echo "::remove-matcher owner=packchk::" | ||
| - name: Archive pack | ||
| if: ${{ github.event_name != 'release' }} | ||
| uses: actions/upload-artifact@v2 | ||
| with: | ||
| path: output/*.pack | ||
| retention-days: 1 | ||
| if-no-files-found: error | ||
|
|
||
| - name: Attach pack to release assets | ||
| if: ${{ github.event_name == 'release' }} | ||
| uses: svenstaro/upload-release-action@v2 | ||
| with: | ||
| repo_token: ${{ secrets.GITHUB_TOKEN }} | ||
| file_glob: true | ||
| file: output/*.pack | ||
| tag: ${{ github.ref }} | ||
| overwrite: true | ||
|
|
||
| - name: Update release description | ||
| if: ${{ github.event_name == 'release' }} | ||
| run: | | ||
| CURRENT="$(gh release view ${{ github.ref }} --json body -t "{{.body}}")" | ||
| if [[ -z "$CURRENT" ]]; then | ||
| DESC=$(git tag -l -n99 --format "%(contents)" ${{ github.ref }}) | ||
| gh release edit -n "$DESC" | ||
| fi | ||
| - uses: actions/checkout@v2 | ||
| if: ${{ github.event_name == 'release' || github.event_name == 'push' || github.event_name == 'workflow_dispatch' }} | ||
| with: | ||
| ref: gh-pages | ||
|
|
||
| - name: Publish documentation | ||
| if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }} | ||
| run: | | ||
| rm -rf main | ||
| mkdir main | ||
| pushd main | ||
| tar -xvjf /tmp/doc.tbz2 | ||
| popd | ||
| ./update_versions.sh | ||
| git config user.name github-actions | ||
| git config user.email github-actions@github.com | ||
| git add . | ||
| git commit -m "Update main documentation" | ||
| git push | ||
| - name: Publish documentation | ||
| if: ${{ github.event_name == 'release' }} | ||
| run: | | ||
| RELEASE=$(echo $GITHUB_REF | sed 's/refs\/tags\///') | ||
| rm -rf ${RELEASE} | ||
| mkdir -p ${RELEASE} | ||
| rm -f latest | ||
| ln -s ${RELEASE} latest | ||
| pushd ${RELEASE} | ||
| tar -xvjf /tmp/doc.tbz2 | ||
| popd | ||
| ./update_versions.sh | ||
| git config user.name github-actions | ||
| git config user.email github-actions@github.com | ||
| git add . | ||
| git commit -m "Update documentation for release ${RELEASE}" | ||
| git push |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| function writeVersionDropdown() { | ||
| }; |
Oops, something went wrong.