Set up publish-docs pipeline job
Open, MediumPublic
Actions

Assigned To

Slst2020

Authored By

	Slst2020
	May 18 2022, 5:37 AM

Description

Define new variant derived from dev-python for building the docs in blubber.yaml
Add a stage to the existing publish pipeline in config.yaml to publish the documentation via a downstream job

Example config.yaml:

stages:
  - name: publish-docs
    build: documentation
    run: true
    copy:
      - source: /srv/app/build/docs/groovydoc
        destination: docs
        archive: true
        trigger:
          name: publish-artifact-to-doc-wikimedia-org
          parameters:
            ARTIFACT_URL: '${.artifactURLs}'
            WMF_CI_PUB_DEST: 'my/project/doc/root'

(from https://gerrit.wikimedia.org/r/c/integration/config/+/792736/)

Details

	Subject	Repo	Branch	Lines +/-
	WIP ci: Publish docs on doc.wikimedia.org	wikimedia/toolhub	main	+26 -0

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Open		Slst2020	T305914 Publish docs on doc.wikimedia.org
		Open		Slst2020	T308632 Set up publish-docs pipeline job

Event Timeline

Slst2020 triaged this task as Medium priority.May 18 2022, 5:37 AM

Slst2020 created this task.

Slst2020 moved this task from Backlog to Groomed/Ready on the Toolhub board.

Slst2020 moved this task from To Do to Doing on the User-Slst2020 board.May 18 2022, 7:13 AM

Slst2020 changed the task status from Open to In Progress.Jun 7 2022, 12:19 PM

Slst2020 updated the task description. (Show Details)

Slst2020 updated the task description. (Show Details)Jun 7 2022, 1:14 PM

Change 803510 had a related patch set uploaded (by Slavina Stefanova; author: Slavina Stefanova):

[wikimedia/toolhub@main] WIP ci: Publish docs on doc.wikimedia.org

https://gerrit.wikimedia.org/r/803510

gerritbot added a project: Patch-For-Review.Jun 7 2022, 1:18 PM

Slst2020 moved this task from Doing to Paused/Blocked on the User-Slst2020 board.Jun 30 2022, 12:57 PM

Slst2020 changed the task status from In Progress to Open.Aug 26 2022, 6:31 AM

In T332953#8879758, @jnuche wrote:

In a project's .gitlab-ci.yml, it is now possible to publish documentation and test coverage results to doc.wikimedia.org using docpub.

You can find usage examples in the README and the scap repo.

If you're interested in using docpub in your new GitLab projects and would like a hand with it, please feel free to give me a shout!

In T332953#8891397, @jnuche wrote:

When you're ready to publish your docs/coverage with docpub, your project members will need to be added to the docpub project in order for you to be able to trigger the downstream pipeline there.

As part of using docpub in your project, please reach out to me so I can add you. Other RelEng members can also help with this in case I'm not available.

We haven't switched from Gerrit to GitLab yet, but when we do this is probably how we will need to publish docs. I think we are soft blocked on T334419: Set up translatewiki.net exports to push (and merge) to Wikimedia GitLab for the switch.

Set up publish-docs pipeline job Open, MediumPublicActions

Description

Details

Related ObjectsSearch...

Event Timeline

Set up publish-docs pipeline job
Open, MediumPublic
Actions

Related Objects
Search...