action #54350

Generate docs for all PRs without publishing them

Added by cdywan 7 months ago. Updated 4 months ago.

Status:ResolvedStart date:17/07/2019
Priority:NormalDue date:
Assignee:andriinikitin% Done:

0%

Category:Feature requests
Target version:Current Sprint
Difficulty:
Duration:

Description

Currently the generate-documentation script checks a few conditions:

  • Branch is master
  • A PR is being built
  • We want to publish the docs

If all of these are true docs are generated and published. Conversely we won't know about problems with docs until after changes have been merged, if these checks do work as specified.

#2188 optimizes the decision to (not) run the script.

We can take it one step further by enabling a job to generate, or generate and publish, in the cases we care for and have the script do one or both. And while we're at it, let's remove the second-guessing from the docs script, and have the logic in one place.


Related issues

Related to openQA Project - action #57548: Move building and publishing of docs to CircleCI Resolved 30/09/2019

History

#1 Updated by okurz 7 months ago

  • Category set to Feature requests

#2 Updated by okurz 4 months ago

  • Status changed from New to Blocked
  • Assignee set to andriinikitin
  • Target version set to Current Sprint

@andriinikitin I assume this is blocked by your work in #57548 , right?

#3 Updated by okurz 4 months ago

  • Blocked by action #57548: Move building and publishing of docs to CircleCI added

#4 Updated by andriinikitin 4 months ago

  • Blocked by deleted (action #57548: Move building and publishing of docs to CircleCI)

#5 Updated by andriinikitin 4 months ago

  • Related to action #57548: Move building and publishing of docs to CircleCI added

#6 Updated by andriinikitin 4 months ago

  • Status changed from Blocked to In Progress

The request "Generate docs for all PRs" was fixed by https://github.com/os-autoinst/openQA/pull/2405 , and documentation is being built in every CI run.
I don't see how " let's remove the second-guessing from the docs script " can be beneficial, so I am not implementing it at the moment.
So I mark this ticket as Resolved, and feel free to reassign it and reopen or create another ticket if you think more work must be done.

#7 Updated by andriinikitin 4 months ago

  • Status changed from In Progress to Resolved

Also available in: Atom PDF