update readme and doc #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
| # This is a basic workflow to help you get started with Actions | |
| name: Build source code and doc | |
| # Controls when the action will run. | |
| on: | |
| # Triggers the workflow on push or pull request events but only for the main branch | |
| push: | |
| branches: [ main ] | |
| # pull_request: | |
| # branches: [ main ] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| permissions: write-all | |
| # 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: | |
| # Only run job for specific repository | |
| if: github.repository == 'sipeed/MaixPy' | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: [3.11] # MaixCAM use 3.11 | |
| # 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@v2 | |
| - name: Build MaixPy | |
| run: | | |
| echo "-- Check python version must python 3.11 --" | |
| python3 -c 'import sys;print(sys.version); assert sys.version_info >= (3, 11)' | |
| python -c 'import sys;print(sys.version); assert sys.version_info >= (3, 11)' | |
| ls -al ~/.local/bin/ | |
| export PATH=~/.local/bin/:$PATH | |
| # pull sipeed/MaixCDK repo here first | |
| git clone https://github.com/sipeed/MaixCDK --depth=1 | |
| export MAIXCDK_PATH=`pwd`/MaixCDK | |
| python -m pip install -U pip setuptools | |
| python -m pip install -r MaixCDK/requirments.txt | |
| echo "----------------------" | |
| echo "-- Build MaixPy now --" | |
| echo "----------------------" | |
| python setup.py bdist_wheel maixcam | |
| # Runs a set of commands using the runners shell | |
| - name: Push doc to github pages | |
| run: | | |
| pip3 install teedoc | |
| cd docs | |
| echo "== install plugins ==" | |
| teedoc install | |
| echo "== start build ==" | |
| teedoc build | |
| echo "== build complete ==" | |
| remote_addr=`git remote get-url --push origin` | |
| remote_addr=`echo $remote_addr| awk -F'://' '{print $2}'` | |
| user_name=`git log -1 --pretty=format:'%an'` | |
| user_email=`git log -1 --pretty=format:'%ae'` | |
| echo "== checkout gh-pages branch ==" | |
| cd out | |
| cp -r ../.github . | |
| git init | |
| git config user.name ${user_name} | |
| git config user.email ${user_email} | |
| remote_addr="https://${user_name}:${{ secrets.GITHUB_TOKEN }}@${remote_addr}" | |
| echo "-- user ${user_name}" | |
| echo "-- remote addr: ${remote_addr}" | |
| git remote add origin "${remote_addr}" | |
| git add -A | |
| git commit -m "Rebuild MaixPy doc by commit $GITHUB_REF" | |
| git push origin HEAD:gh-pages --force | |
| echo "== push complete ==" |