Task Force Proposal: Best Practices for Automated Pipelines

[tkuhrt]

Introduction/background material

In the first meeting of the 2023 TOC, @swcurran suggested we look at creating best practices for automated pipelines

Task to be completed

Document the best practices for how to produce and publish artifacts

List of deliverables or work products

• [ ] Best practices for automated pipeline

Time to complete (no more than 6 months)

TBD

Leader

@petermetz

Initial participant list

• Marcus Brandenburger
• Dave Enyeart
• Timo Glastra

[tkuhrt]

Discussion from June 1st TOC meeting on scope of task force:

• Best practices on GitHub Workflow Actions (with pointers to GitHub documentation)
• General checkup of CI workflows where times are high across our repos --> this would lead to a best practices/learnings section
• Moonshot: Evaluate self-hosted alternatives to what buildjet offers commercially --> report of options available

[tkuhrt]

Discussion from June 20th TOC meeting:

• Build dependency caching
• Cross-platform scripts allow to debug CI locally
• Evaluate an open-source alternative for buildjet that we could self-host -- could not find anything. So the Moonshot is paused.
• ACT tool to run CI locally
• Success with dedicated runners on the Fabric CI (factor of 2x)
• Best practices document has some details that we need to include
• Survey to collect thoughts on best practices and pain points that can be sent to the community
• Targeted integration tests based on files in the PR
• Where artifacts be published, how often
• When releases should be tagged
• https://wiki.hyperledger.org/display/TF/Best+Practices+for+Automated+Pipelines