add readme #19
Merged
add readme #19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thaJeztah
reviewed
Jun 22, 2017
readme.md
Outdated
| ### Important: This repository is in an early development phase and not suitable for practical workloads. It does not compare with `docker build` features yet. | ||
|
|
||
|
|
||
| ## Buildkit |
There was a problem hiding this comment.
I think we standardised on using capital K for the kits (BuildKit)
There was a problem hiding this comment.
(here, and other occurrences below)
thaJeztah
requested changes
Jun 23, 2017
readme.md
Outdated
|
|
||
| [](https://asciinema.org/a/gPEIEo1NzmDTUu2bEPsUboqmU) | ||
|
|
||
| Buildkit daemon can be built in two different versions: one that uses [containerd](https://github.com/containerd/containerd) for execution and distribution and a standalone version that doesn't have other dependencies apart from [runc](https://github.com/opencontainers/runc). We are open for adding more backends. `buildd` is a CLI utility for running the gRPC API. |
There was a problem hiding this comment.
s/Buildkit daemon/The BuildKit daemon/ ?
There was a problem hiding this comment.
"for execution and distribution and a standalone" -> "for execution and distribution, and a standalone" (add comma before the last "and")
readme.md
Outdated
|
|
||
| Buildkit daemon can be built in two different versions: one that uses [containerd](https://github.com/containerd/containerd) for execution and distribution and a standalone version that doesn't have other dependencies apart from [runc](https://github.com/opencontainers/runc). We are open for adding more backends. `buildd` is a CLI utility for running the gRPC API. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
can you add a bash language-hint here?
readme.md
Outdated
|
|
||
| You can use `buildctl debug dump` to see what data is this definition. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
```bash(here, and other occurrences)
readme.md
Outdated
| ``` | ||
|
|
||
| To start building use `buildctl build` command. The script accepts `--target` flag to choose between `containerd` and `standalone` configurations. In standalone mode buildkit binaries are built together with `runc`. In containerd mode, `containerd` binary is built as well from the upstream repo. | ||
|
|
There was a problem hiding this comment.
"containerd binary is built as well" -> "the containerd binary is built as well..."
readme.md
Outdated
|
|
||
| ``` | ||
| make validate-all | ||
| ``` |
There was a problem hiding this comment.
Will this repository stay in your name, or be moved to the "docker" or "moby" org?
Can you also;
- add a
CONTRIBUTING.md(like https://github.com/linuxkit/linuxkit/blob/master/CONTRIBUTING.md) and link it from here? - add a link to the license here (
Released under the [Apache 2.0 license](LICENSE).) - fill in the copyright owner, and year in the license
- add a
NOTICEfile (like https://github.com/linuxkit/linuxkit/blob/master/NOTICE) - add a poule.yml (assuming we'll be using the regular review procedure); https://github.com/linuxkit/linuxkit/blob/master/poule.yml - may have to add the right labels as well
- add a
MAINTAINERSfile (https://github.com/docker/opensource/blob/master/project-template/MAINTAINERS)
We may have to configure leeroy to do the DCO check on PR's 😄
Let me know if you want me to take care of those
There was a problem hiding this comment.
Let's leave these to separate PR
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
thaJeztah
approved these changes
Jun 23, 2017
alexcb
added a commit
to alexcb/buildkit
that referenced
this pull request
Jan 21, 2021
- fix IsSSHTransport to also check for explicitly-defined ssh-based git repos Signed-off-by: Alex Couture-Beil <alex@earthly.dev>
goller
added a commit
to goller/buildkit
that referenced
this pull request
Jun 6, 2023
fix(debug): check for nil payload
alexcb
added a commit
to alexcb/buildkit
that referenced
this pull request
Sep 13, 2023
Open files for local writes with truncate flag
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@thaJeztah
Signed-off-by: Tonis Tiigi tonistiigi@gmail.com