Skip to content
This repository has been archived by the owner on Sep 5, 2019. It is now read-only.

Update README to note deprecation #655

Merged
merged 3 commits into from Sep 4, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
58 changes: 58 additions & 0 deletions README-old.md
@@ -0,0 +1,58 @@
# Knative Build

:rotating_light: **NOTE: Knative Build is
[deprecated](https://github.com/knative/build/issues/614) in favor of [Tekton
Pipelines](https://github.com/tektoncd/pipeline). There are no plans to
produce future releases of this component.** :rotating_light:

**This version of README.md is provided for historical purposes.**

[![GoDoc](https://godoc.org/github.com/knative/build?status.svg)](https://godoc.org/github.com/knative/build)
[![Go Report Card](https://goreportcard.com/badge/knative/build)](https://goreportcard.com/report/knative/build)

This repository contains a work-in-progress build system that is designed to
address a common need for cloud native development.

A Knative build extends
[Kubernetes](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
and utilizes existing Kubernetes primitives to provide you with the ability to
run on-cluster container builds from source. For example, you can write a build
that uses Kubernetes-native resources to obtain your source code from a
repository, build a container image, then run that image.

While Knative builds are optimized for building, testing, and deploying source
code, you are still responsible for developing the corresponding components
that:

- Retrieve source code from repositories.
- Run multiple sequential jobs against a shared filesystem, for example:
- Install dependencies.
- Run unit and integration tests.
- Build container images.
- Push container images to an image registry, or deploy them to a cluster.

The goal of a Knative build is to provide a standard, portable, reusable, and
performance optimized method for defining and running on-cluster container image
builds. By providing the “boring but difficult” task of running builds on
Kubernetes, Knative saves you from having to independently develop and reproduce
these common Kubernetes-based development processes.

While today, a Knative build does not provide a complete standalone CI/CD
solution, it does however, provide a lower-level building block that was
purposefully designed to enable integration and utilization in larger systems.

## Learn more

To learn more about builds in Knative, see the
[Knative build documentation](https://www.knative.dev/docs/build/).

To learn more about Knative in general,
[see the documentation](https://www.knative.dev/docs/).

## Developing Knative builds

If you are interested in contributing to Knative builds:

1. Visit the [How to contribute](./CONTRIBUTING.md) page for information about
how to become a Knative contributor.
1. Learn how to [set up your development environment](DEVELOPMENT.md).
61 changes: 6 additions & 55 deletions README.md
@@ -1,58 +1,9 @@
# Knative Build

> :rotating_light: **NOTE: There is
> [an open proposal to deprecate this component](https://github.com/knative/build/issues/614)
> in favor of [Tekton Pipelines](https://github.com/tektoncd/pipeline). If you
> are a new user, consider using Tekton Pipelines, or another tool, to build and
> release. If you use Knative Build today, please give feedback on the
> deprecation proposal.**
:rotating_light: **NOTE: Knative Build is
[deprecated](https://github.com/knative/build/issues/614) in favor of [Tekton
Pipelines](https://github.com/tektoncd/pipeline). There are no plans to
produce future releases of this component.** :rotating_light:

[![GoDoc](https://godoc.org/github.com/knative/build?status.svg)](https://godoc.org/github.com/knative/build)
[![Go Report Card](https://goreportcard.com/badge/knative/build)](https://goreportcard.com/report/knative/build)

This repository contains a work-in-progress build system that is designed to
address a common need for cloud native development.

A Knative build extends
[Kubernetes](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
and utilizes existing Kubernetes primitives to provide you with the ability to
run on-cluster container builds from source. For example, you can write a build
that uses Kubernetes-native resources to obtain your source code from a
repository, build a container image, then run that image.

While Knative builds are optimized for building, testing, and deploying source
code, you are still responsible for developing the corresponding components
that:

- Retrieve source code from repositories.
- Run multiple sequential jobs against a shared filesystem, for example:
- Install dependencies.
- Run unit and integration tests.
- Build container images.
- Push container images to an image registry, or deploy them to a cluster.

The goal of a Knative build is to provide a standard, portable, reusable, and
performance optimized method for defining and running on-cluster container image
builds. By providing the “boring but difficult” task of running builds on
Kubernetes, Knative saves you from having to independently develop and reproduce
these common Kubernetes-based development processes.

While today, a Knative build does not provide a complete standalone CI/CD
solution, it does however, provide a lower-level building block that was
purposefully designed to enable integration and utilization in larger systems.

## Learn more

To learn more about builds in Knative, see the
[Knative build documentation](https://www.knative.dev/docs/build/).

To learn more about Knative in general,
[see the documentation](https://www.knative.dev/docs/).

## Developing Knative builds

If you are interested in contributing to Knative builds:

1. Visit the [How to contribute](./CONTRIBUTING.md) page for information about
how to become a Knative contributor.
1. Learn how to [set up your development environment](DEVELOPMENT.md).
The original README can be found [here](./README-old.md) for historical
purposes.