mirror of
https://github.com/deepset-ai/haystack.git
synced 2025-12-31 09:10:15 +00:00
2d65c380f1
* Add pre-commit config * update contributing guidelines * try failing the workflow * add pre-commit to the deps * updating uninstall instructions * separate jobs in CI * make tutorials check fail * make black check fail * make openapi check fail * make yaml schema and api docs checks fail * highlight the instructions * Update .pre-commit-config.yaml Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de> * Update CONTRIBUTING.md Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de> * Update CONTRIBUTING.md Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de> * Use black --check * Add images of the CI * title level * feedback Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de>
50 lines
1.6 KiB
YAML
50 lines
1.6 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
workflow_dispatch: # Activate this workflow manually
|
|
pull_request:
|
|
|
|
jobs:
|
|
|
|
api-docs:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
|
|
- uses: actions/checkout@v2
|
|
|
|
- name: Setup Python
|
|
uses: ./.github/actions/python_cache/
|
|
|
|
- name: Install Haystack
|
|
run: |
|
|
pip install --upgrade pip
|
|
pip install -U .[dev]
|
|
|
|
- name: Update API documentation
|
|
run: .github/utils/pydoc-markdown.sh
|
|
|
|
- name: Check status
|
|
run: |
|
|
if [[ `git status --porcelain` ]]; then
|
|
git status
|
|
echo "###################################################################################################"
|
|
echo "# "
|
|
echo "# CHECK FAILED! The API docs were not updated."
|
|
echo "# "
|
|
echo "# Either:"
|
|
echo "# 1. Generate the new API docs locally before committing:"
|
|
echo "# "
|
|
echo "# .github/utils/pydoc-markdown.sh"
|
|
echo "# "
|
|
echo "# 2. Install the pre-commit hook:"
|
|
echo "# "
|
|
echo "# pre-commit install --hook-type pre-push"
|
|
echo "# "
|
|
echo "# 3. See https://github.com/deepset-ai/haystack/blob/master/CONTRIBUTING.md for help."
|
|
echo "# "
|
|
echo "# If you have further problems, please open an issue: https://github.com/deepset-ai/haystack/issues"
|
|
echo "# "
|
|
echo "###################################################################################################"
|
|
exit 1
|
|
fi
|