Skip to content

Hotfix: Docs GH Action Looping Infinitely #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 25, 2024
Merged

Hotfix: Docs GH Action Looping Infinitely #246

merged 1 commit into from
Nov 25, 2024

Conversation

johnwalz97
Copy link
Contributor

Internal Notes for Reviewers

Adding a paths-ignore clause to stop the docs GH action from running if the only changes are to the docs build folder.

External Release Notes

@johnwalz97 johnwalz97 added bug Something isn't working internal Not to be externalized in the release notes labels Nov 25, 2024
@github-actions GitHub Actions
Copy link
Contributor

PR Summary

This pull request updates the GitHub Actions workflow for generating Python library API documentation. The changes include:

  • Ignoring paths under docs/_build/** during push events to prevent unnecessary workflow runs when only built documentation files are modified.
  • Minor formatting adjustments in the YAML file, such as changing double quotes to single quotes for consistency.

These changes aim to optimize the workflow by reducing unnecessary triggers and ensuring consistent formatting.

Test Suggestions

  • Verify that the workflow triggers correctly on pushes to the 'main' and 'release-v1' branches, except when changes are only in 'docs/_build/**'.
  • Check that the workflow can be manually triggered using the 'workflow_dispatch' event.
  • Ensure that the documentation is generated correctly and committed to the repository when the workflow runs.

cachafla
cachafla approved these changes Nov 25, 2024
View reviewed changes
Copy link
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 👌

@johnwalz97 johnwalz97 merged commit a576af5 into main Nov 25, 2024
8 checks passed
@johnwalz97 johnwalz97 deleted the john6797/hotfix-docs-action-infinite-loop branch November 25, 2024 18:26
johnwalz97 added a commit that referenced this pull request Dec 2, 2024
@johnwalz97
Squashed commit of the following:
cb72eff 
commit 315b51b
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 29 13:38:46 2024 +0100

    Remove exit call

commit c46430e
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 29 13:25:44 2024 +0100

    Add "time_series_data" tag to TimeSeriesHistogram test

commit bba0218
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 29 11:45:45 2024 +0100

    Remove AutoSeasonality test

commit d97828e
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 29 11:19:04 2024 +0100

    Fix AutoStationarity unit test

commit 4ea3e37
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 29 10:18:50 2024 +0100

    Merge with Main

commit ae74f94
Merge: 19ff797 0efdb80
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 29 10:18:14 2024 +0100

    Merge branch 'main'

commit 19ff797
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 29 09:59:06 2024 +0100

    Remove prints

commit cb58ac5
Author: Juan <juan@validmind.ai>
Date:   Thu Nov 28 21:23:06 2024 +0100

    Skip ragas unit tests

commit cdb77f6
Author: Juan <juan@validmind.ai>
Date:   Thu Nov 28 18:05:29 2024 +0100

    Remove "Initializing VM Dataset" logger

commit 825c07e
Author: Juan <juan@validmind.ai>
Date:   Thu Nov 28 17:59:46 2024 +0100

    Add unit test for data validation

commit 1de976a
Author: Juan <juan@validmind.ai>
Date:   Thu Nov 28 15:00:30 2024 +0100

    Add unit test for ROCCurve

commit 448867d
Merge: fabe302 f0773a0
Author: Juan <juan@validmind.ai>
Date:   Thu Nov 28 09:23:12 2024 +0100

    Merge branch 'main'

commit fabe302
Author: Juan <juan@validmind.ai>
Date:   Thu Nov 28 09:18:49 2024 +0100

    Add data validation unit tests

commit 76dd39e
Author: Juan <juan@validmind.ai>
Date:   Wed Nov 27 09:38:37 2024 +0100

    Update run.py

commit b6638b2
Merge: e59d0c6 d469979
Author: Juan <juan@validmind.ai>
Date:   Wed Nov 27 09:34:13 2024 +0100

    Merge branch 'main'

commit e59d0c6
Author: Juan <juan@validmind.ai>
Date:   Tue Nov 26 18:56:09 2024 +0100

    Added unit tests for ADF and AutoAR

commit 1edcd59
Merge: b2c8476 1efef2b
Author: Juan <juan@validmind.ai>
Date:   Mon Nov 25 23:02:42 2024 +0100

    Merge branch 'main'

commit 1efef2b
Merge: 7602035 0b33f99
Author: John Halz <johnwalz97@gmail.com>
Date:   Mon Nov 25 15:11:10 2024 -0500

    Merge pull request #240 from validmind/john6797/sc-6928/backend-should-store-metadata-of-the-python

commit 7602035
Merge: 26af91e 9e2ec26
Author: Andres Rodriguez <andres@validmind.ai>
Date:   Mon Nov 25 11:59:40 2024 -0800

    Merge pull request #228 from validmind/dependabot/pip/notebook-7.2.2

    chore(deps-dev): bump notebook from 7.0.7 to 7.2.2

commit 26af91e
Merge: a576af5 5f2d411
Author: Andres Rodriguez <andres@validmind.ai>
Date:   Mon Nov 25 11:58:32 2024 -0800

    Merge pull request #241 from validmind/dependabot/pip/tornado-6.4.2

    build(deps-dev): bump tornado from 6.4.1 to 6.4.2

commit b2c8476
Author: Juan <juan@validmind.ai>
Date:   Mon Nov 25 19:44:56 2024 +0100

    Fix lint

commit 9af2500
Merge: 36c4899 a576af5
Author: Juan <juan@validmind.ai>
Date:   Mon Nov 25 19:41:22 2024 +0100

    Merge branch 'main'

commit a576af5
Merge: cc9d78c fae09c7
Author: John Halz <john@validmind.ai>
Date:   Mon Nov 25 13:24:27 2024 -0500

    Merge pull request #246 from validmind/john6797/hotfix-docs-action-infinite-loop

    Hotfix: Docs GH Action Looping Infinitely

commit 36c4899
Author: Juan <juan@validmind.ai>
Date:   Mon Nov 25 19:08:16 2024 +0100

    Run poetry lock

commit fae09c7
Author: John Walz <john@validmind.ai>
Date:   Mon Nov 25 13:06:39 2024 -0500

    fix: docs action is looping continuously - ignore updates to docs build folder when triggering the action

commit 8448034
Merge: ffa6a87 cc9d78c
Author: Juan <juan@validmind.ai>
Date:   Mon Nov 25 18:55:30 2024 +0100

    Merge branch 'main'

commit 888c423
Merge: 97bf57e 35ec7fa
Author: John Walz <john@validmind.ai>
Date:   Fri Nov 22 13:49:56 2024 -0500

    Merge branch 'main' into john6797/sc-6928/backend-should-store-metadata-of-the-python

commit 97bf57e
Author: John Walz <john@validmind.ai>
Date:   Fri Nov 22 13:49:49 2024 -0500

    refactor: move metadata (tasks and tags) into load.py

commit cb895a3
Author: John Walz <john@validmind.ai>
Date:   Fri Nov 22 13:48:41 2024 -0500

    fix: fix unit metrics run_metric so integration tests notebook passes

commit 35ec7fa
Author: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Date:   Fri Nov 22 18:47:35 2024 +0000

    Generate docs

commit 9e2ec26
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Fri Nov 22 18:41:49 2024 +0000

    chore(deps-dev): bump notebook from 7.0.7 to 7.2.2

    Bumps [notebook](https://github.com/jupyter/notebook) from 7.0.7 to 7.2.2.
    - [Release notes](https://github.com/jupyter/notebook/releases)
    - [Changelog](https://github.com/jupyter/notebook/blob/@jupyter-notebook/tree@7.2.2/CHANGELOG.md)
    - [Commits](https://github.com/jupyter/notebook/compare/@jupyter-notebook/tree@7.0.7...@jupyter-notebook/tree@7.2.2)

    ---
    updated-dependencies:
    - dependency-name: notebook
      dependency-type: indirect
    ...

    Signed-off-by: dependabot[bot] <support@github.com>

commit e971351
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 22 19:06:40 2024 +0100

    Remove teardown

commit 28d3ad2
Merge: b517dca 87475bc
Author: Juan <juan@validmind.ai>
Date:   Thu Nov 21 17:37:01 2024 +0100

    Merge into 'Main'

commit b517dca
Author: Juan <juan@validmind.ai>
Date:   Mon Nov 18 16:33:35 2024 +0100

    Add ragas unit tests

commit 182bbb5
Author: Juan <juan@validmind.ai>
Date:   Mon Nov 18 12:35:06 2024 +0100

    Add unit tests for model validation vm tests

commit 97878b5
Author: Juan <juan@validmind.ai>
Date:   Sat Nov 16 09:13:35 2024 +0100

    Add unit test for statsmodels

commit f7b2352
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 15 16:33:16 2024 +0100

    Add NLP unit tests

commit 7f7d185
Merge: 2b5247b 1dbbba1
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 15 14:09:33 2024 +0100

    Merge branch 'main'

commit 2b5247b
Author: Juan <juan@validmind.ai>
Date:   Fri Nov 15 14:01:47 2024 +0100

    Add data_validation unit tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cachafla cachafla cachafla approved these changes

@eggshell eggshell Awaiting requested review from eggshell

@juanmleng juanmleng Awaiting requested review from juanmleng

Assignees
No one assigned
Labels
bug Something isn't working internal Not to be externalized in the release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@johnwalz97 @cachafla