semaphoreci / semaphore

Apache License 2.0
7 stars 0 forks source link

[Docs]: Initialization jobs #60

Open TomFern opened 3 weeks ago

TomFern commented 3 weeks ago

Type

Improvement idea

What do you want to report?

Initialization jobs are not explained in detail. We should explain how they work in the pipeline pages. Explain when and what they run. Add a link from Organizations > Initialization Jobs to the new explanation.

The concept of the initialization job should be covered on the pipeline page:

When does it run? What does it do? Clone repo, gets the yaml? Mention esp which is open source Mention the compilation/parse step of the yaml Be more detailed, and technical. We may need to touch base with engineering/product for this.

The current docs also don't cover the details: https://docs.semaphoreci.com/reference/pipeline-initialization/

Background: The initialization job under Organization settings was introduced for on-prem folks because the default machine is not available there.

Code of Conduct