Document the process of creating a cookbook CI pipeline using Github Actions
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
General details
Link to page & section that needs updated: This page currently does not exist
Business group: product
Product owner: ME!
Team: Workstation
Date update needs to be published: 2021
Product
- Chef Automate
- Chef Habitat
- Chef Infra Client
- Chef Infra Server
- Chef InSpec
- Chef Workstation
- Other:
Update details
A leading indicator of customer success is CI pipelines for their cookbooks. We need to describe how to use Chef Workstation with the various CI tools out there in order to test cookbooks. GitHub action is a pretty simple setup and a good starting point for this work.
Existing resources
GitHub Repository: Anything in the sous-chefs org
Issue link(s):
PR link(s):
AHA! link(s):
Other draft documentation:
Related design, business docs, or other information:
Review
Name of technical reviewer:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the Chef Workstation documentation structure and the existing resources in the sous-chefs organization first; no target file or test is named. Define the new page around creating a cookbook CI pipeline with GitHub Actions, and consider the documentation complete when the setup and cookbook-testing process are clearly described and published.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100