123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110 |
- # Ultralytics YOLO 🚀, AGPL-3.0 license
- # Publish pip package to PyPI https://pypi.org/project/ultralytics/ and Docs to https://docs.ultralytics.com
- name: Publish to PyPI and Deploy Docs
- on:
- push:
- branches: [main]
- workflow_dispatch:
- inputs:
- pypi:
- type: boolean
- description: Publish to PyPI
- docs:
- type: boolean
- description: Deploy Docs
- jobs:
- publish:
- if: github.repository == 'ultralytics/ultralytics' && github.actor == 'glenn-jocher'
- name: Publish
- runs-on: ubuntu-latest
- steps:
- - name: Checkout code
- uses: actions/checkout@v3
- with:
- fetch-depth: "0" # pulls all commits (needed correct last updated dates in Docs)
- - name: Set up Python environment
- uses: actions/setup-python@v4
- with:
- python-version: '3.10'
- cache: 'pip' # caching pip dependencies
- - name: Install dependencies
- run: |
- python -m pip install --upgrade pip wheel build twine
- pip install -e ".[dev]" --extra-index-url https://download.pytorch.org/whl/cpu
- - name: Check PyPI version
- shell: python
- run: |
- import os
- import pkg_resources as pkg
- import ultralytics
- from ultralytics.utils.checks import check_latest_pypi_version
- v_local = pkg.parse_version(ultralytics.__version__).release
- v_pypi = pkg.parse_version(check_latest_pypi_version()).release
- print(f'Local version is {v_local}')
- print(f'PyPI version is {v_pypi}')
- d = [a - b for a, b in zip(v_local, v_pypi)] # diff
- increment = (d[0] == d[1] == 0) and d[2] == 1 # only publish if patch version increments by 1
- os.system(f'echo "increment={increment}" >> $GITHUB_OUTPUT')
- os.system(f'echo "version={ultralytics.__version__}" >> $GITHUB_OUTPUT')
- if increment:
- print('Local version is higher than PyPI version. Publishing new version to PyPI ✅.')
- id: check_pypi
- - name: Publish to PyPI
- continue-on-error: true
- if: (github.event_name == 'push' || github.event.inputs.pypi == 'true') && steps.check_pypi.outputs.increment == 'True'
- env:
- PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
- run: |
- python -m build
- python -m twine upload dist/* -u __token__ -p $PYPI_TOKEN
- - name: Deploy Docs
- continue-on-error: true
- if: (github.event_name == 'push' || github.event.inputs.docs == 'true') && github.repository == 'ultralytics/ultralytics' && github.actor == 'glenn-jocher'
- env:
- PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
- run: |
- mkdocs build
- git config --global user.name "Glenn Jocher"
- git config --global user.email "glenn.jocher@ultralytics.com"
- git clone https://github.com/ultralytics/docs.git docs-repo
- cd docs-repo
- git checkout gh-pages || git checkout -b gh-pages
- rm -rf *
- cp -R ../site/* .
- git add .
- git commit -m "Update Docs for 'ultralytics ${{ steps.check_pypi.outputs.version }}'"
- git push https://${{ secrets.PERSONAL_ACCESS_TOKEN }}@github.com/ultralytics/docs.git gh-pages
- - name: Extract PR Details
- run: |
- if [ "${{ github.event_name }}" = "pull_request" ]; then
- PR_JSON=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }})
- PR_NUMBER=${{ github.event.pull_request.number }}
- PR_TITLE=$(echo $PR_JSON | jq -r '.title')
- else
- COMMIT_SHA=${{ github.event.after }}
- PR_JSON=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" "https://api.github.com/search/issues?q=repo:${{ github.repository }}+is:pr+is:merged+sha:$COMMIT_SHA")
- PR_NUMBER=$(echo $PR_JSON | jq -r '.items[0].number')
- PR_TITLE=$(echo $PR_JSON | jq -r '.items[0].title')
- fi
- echo "PR_NUMBER=$PR_NUMBER" >> $GITHUB_ENV
- echo "PR_TITLE=$PR_TITLE" >> $GITHUB_ENV
- - name: Notify on Slack (Success)
- if: success() && github.event_name == 'push' && steps.check_pypi.outputs.increment == 'True'
- uses: slackapi/slack-github-action@v1.24.0
- with:
- payload: |
- {"text": "<!channel> GitHub Actions success for ${{ github.workflow }} ✅\n\n\n*Repository:* https://github.com/${{ github.repository }}\n*Action:* https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}\n*Author:* ${{ github.actor }}\n*Event:* NEW 'ultralytics ${{ steps.check_pypi.outputs.version }}' pip package published 😃\n*Job Status:* ${{ job.status }}\n*Pull Request:* <https://github.com/${{ github.repository }}/pull/${{ env.PR_NUMBER }}> ${{ env.PR_TITLE }}\n"}
- env:
- SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL_YOLO }}
- - name: Notify on Slack (Failure)
- if: failure()
- uses: slackapi/slack-github-action@v1.24.0
- with:
- payload: |
- {"text": "<!channel> GitHub Actions error for ${{ github.workflow }} ❌\n\n\n*Repository:* https://github.com/${{ github.repository }}\n*Action:* https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}\n*Author:* ${{ github.actor }}\n*Event:* ${{ github.event_name }}\n*Job Status:* ${{ job.status }}\n*Pull Request:* <https://github.com/${{ github.repository }}/pull/${{ env.PR_NUMBER }}> ${{ env.PR_TITLE }}\n"}
- env:
- SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL_YOLO }}
|