Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document pipeline types #875

Open
sxa opened this issue Jan 8, 2024 · 1 comment
Open

Document pipeline types #875

sxa opened this issue Jan 8, 2024 · 1 comment
Labels
documentation generation Issues that provide enhancements or fixes to the job generators testing

Comments

@sxa
Copy link
Member

sxa commented Jan 8, 2024

Please describe what you want to be able to do that isn't documented and/or what you'd like to see in the documentation

We now have a large number of build types executed through pipelines:

  • Nightly
  • EA triggered builds
  • Release builds
  • Evaluation builds
  • Weekend runs
  • (Forthcoming) Trestle pipelines

Given the expansion of the different types we should have clear documentation on:

  • what each of those are for
  • what testing is done on them
  • whether they are published (and whether the artifacts are renamed during the publish step)
  • the scheduling/triggering
  • where to find the jobs
  • how/when they are regenerated by automation

I would suggest this might be in a table in the README.md or FAQ.md in this repository but open to other suggestions. This will help people understand what we're doing and when we're doing it.

Related:

@github-actions github-actions bot added the generation Issues that provide enhancements or fixes to the job generators label Jan 29, 2024
@sxa
Copy link
Member Author

sxa commented Jan 29, 2024

Related (dup?) of #586

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation generation Issues that provide enhancements or fixes to the job generators testing
Projects
Status: Todo
Development

No branches or pull requests

1 participant