Skip to content

Commit

Permalink
tested that docs are ready to deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
blaise-muhirwa committed Oct 11, 2023
1 parent 693feec commit d60b398
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 54 deletions.
35 changes: 18 additions & 17 deletions .github/workflows/cicd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ jobs:
# Run integration tests against the API (only on the main branch, though). The comprehensive
# version runs a matrix of python versions for better coverage.
test-comprehensive:
# if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v')
if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v')
needs:
- test-simple
- test-docs
Expand Down Expand Up @@ -214,7 +214,7 @@ jobs:
# TODO: We'd like to build on pushes on any branch when docs/** changes. But then only deploy if
# we are on the `main` branch and docs/** has changes.
deploy-docs:
# if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v')
if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v')
needs:
- test-comprehensive
- test-api-reference-docs
Expand All @@ -233,6 +233,7 @@ jobs:
- name: Install dependencies
run: npm install
- name: Download api-reference docs
# download docs to python-sdk/api-reference-docs
uses: actions/download-artifact@v2
with:
name: api-reference-docs
Expand All @@ -245,21 +246,21 @@ jobs:
mv ../api-reference-docs/* static/api-reference-docs/
- name: Build website
run: npm run build
# - name: Deploy website (if on main branch)
# # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
# uses: peaceiris/actions-gh-pages@v3
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: ./docs/build
# # Someday we might want to set the destination to a staging dir for PR's
# #destination_dir: staging
# # The following lines assign commit authorship to the official
# # GH-Actions bot for deploys to `gh-pages` branch:
# # https://github.com/actions/checkout/issues/13#issuecomment-724415212
# # The GH actions bot is used by default if you didn't specify the two fields.
# # You can swap them out with your own user credentials.
# user_name: github-actions[bot]
# user_email: 41898282+github-actions[bot]@users.noreply.github.com
- name: Deploy website (if on main branch)
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build
# Someday we might want to set the destination to a staging dir for PR's
#destination_dir: staging
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com

# When a release is created on github (and comprehensive tests passed), publish the groundlight
# package to public pypi.
Expand Down
35 changes: 0 additions & 35 deletions .github/workflows/sphinx_docs.yaml

This file was deleted.

3 changes: 1 addition & 2 deletions test/integration/test_groundlight.py
Original file line number Diff line number Diff line change
Expand Up @@ -363,8 +363,7 @@ def test_submit_numpy_image(gl: Groundlight, detector: Detector):
assert is_valid_display_result(_image_query.result)


# @pytest.mark.skipif(MISSING_PIL, reason="Needs pillow") # type: ignore
@pytest.mark.skip
@pytest.mark.skipif(MISSING_PIL, reason="Needs pillow") # type: ignore
def test_detector_improvement(gl: Groundlight):
# test that we get confidence improvement after sending images in
# Pass two of each type of image in
Expand Down

0 comments on commit d60b398

Please sign in to comment.