Welcome to Project Shipwright!

This is the central hub for community process documentation, as well as assets owned by the project.

What is Shipwright?

Shipwright is a framework for building container images on Kubernetes. The core consists of the following code repositories:

• build - the Build APIs and associated controller to run builds.
• cli - the shp command line for Shipwright builds
• operator - an operator to install Shipwright components on Kubernetes via OLM.

Documentation is spread across the code repositories, and is consolidated in the website repository.

How can I get involved?

• Review our Contributing Guide.
• Join our mailing lists for users or contributors
• Talk with us on the Kubernetes Slack - #shipwright channel
• Attend one of our community meetings - see our public calendar for up to date information.
  • Weekly Community Update - every Monday, 9AM Eastern Time
  • Bi-weekly Backlog Refinement - every other Thursday, 10AM Eastern Time

SHIPs

Enhancements to Shipwright are discussed through the Shipwright Improvement Proposal (SHIP) process. If you have an idea that you want to submit to Shipwright, please read the proposal process guidelines.

Icons and logos

Graphic assets for the project, such as official logos, are located under the assets directory.

License

Unless otherwise noted, all Project Shipwright code and assets are copyrighted under the Apache 2.0 license.

Copyright The Shipwright Contributors

SPDX-License-Identifier: Apache-2.0