deploy-docs-dev fails silently
- Dominant language
- Python
- Stars
- 19
- Forks
- 7
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 67
Description
### 🔍 Before submitting the issue
- [x] I have searched among the existing issues
- [x] I am using a Python virtual environment
### 🐞 Description of the bug
I think this is a corner case. The moment I added the `deploy-docs-pr` to the ci, the `deploy-docs-dev` fails with `Error: Process completed with exit code 1.` and no logs as for why.
### 📝 Steps to reproduce
- `doc-build` + `deploy-docs-dev` works.
- `doc-build` + `deploy-docs-pr` + `deploy-docs-dev` does not work.
# Script to reproduce the issue
```yaml
name: GitHub CI
on:
pull_request:
workflow_dispatch:
push:
tags:
- "*"
branches:
- main
env:
MAIN_PYTHON_VERSION: '3.11'
DOCUMENTATION_CNAME: example.com
jobs:
docs-build:
name: Building Documentation
runs-on: ubuntu-latest
steps:
- name: Build documentation
uses: ansys/actions/doc-build@a5b0351dc277d68c2dc1beca2d2674c7dfa4fc55 # v10.3.3
with:
python-version: ${{ env.MAIN_PYTHON_VERSION }}
group-dependencies-name: "doc"
skip-dependencies-cache: true
deploy-docs-pr:
name: Deploy PR docs
runs-on: ubuntu-latest
needs: docs-build
if: github.event_name == 'pull_request'
permissions:
contents: write
pull-requests: write
steps:
- name: Checkout repository
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
- name: Deploy PR documentation
uses: ansys/actions/doc-deploy-pr@a5b0351dc277d68c2dc1beca2d2674c7dfa4fc55 # v10.3.3
with:
cname: ${{ env.DOCUMENTATION_CNAME }}
token: ${{ secrets.GITHUB_TOKEN }}
bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
deploy-docs-dev:
name: Deploy development docs (on main branch)
runs-on: ubuntu-latest
needs: docs-build
if: github.ref == 'refs/heads/main'
permissions:
contents: write
steps:
- name: Checkout repository
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
- name: Deploy development documentation
uses: ansys/actions/doc-deploy-dev@a5b0351dc277d68c2dc1beca2d2674c7dfa4fc55 # v10.3.3
with:
cname: ${{ env.DOCUMENTATION_CNAME }}
token: ${{ secrets.GITHUB_TOKEN }}
bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
```
### 💻 Which operating system are you using?
Windows
### 📀 Which ANSYS version are you using?
_No response_
### 🐍 Which Python version are you using?
3.10
### 📦 Installed packages
```shell
Not related.
```
Contributor guide
Research direction
Start with the workflow shown in the issue, especially the deploy-docs-pr and deploy-docs-dev jobs and their needs and if conditions. Reproduce the sequence with doc-build, deploy-docs-pr, and deploy-docs-dev, then inspect the ansys/actions doc-deploy-pr and doc-deploy-dev action behavior. Done means the development deployment no longer fails silently and provides enough output to identify failures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100