Continue docs artifact upload even on error

Open Beginner friendly
#229 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions, python
Domain
ci-cd

Research direction

Inspect the CI workflow containing the docs artifact upload and start by running tox -e docs to reproduce the warning-to-error behavior. Ensure the artifact is uploaded even when the docs build fails, then verify the workflow still reports the failure while preserving the artifact; check whether other CI artifact uploads have the same issue.

Written by the indexing model from the issue text.

Description

At the moment, the minute that sphinx makes a warning, it is converted to error so that tox -e docs fails. This is good, but it means we don't get the artifact of the docs build uploaded. We should make the artifact job action if: always() so that it always uploads. There may be other places in the CI we also wish to do this

Dominant language
Jinja
Stars
25
Forks
10
Avg merge
4d 17h
Merged PRs (30d)
7

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DiamondLightSource/python-copier-template

All issues in DiamondLightSource/python-copier-template

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.