Document registries and packaging process #962
Conversation
|
|
||
| ### `VCS.json` | ||
|
|
||
| File containing info about version control system used in your package.\ |
There was a problem hiding this comment.
| File containing info about version control system used in your package.\ | |
| File containing info about version control system used in your package. |
| ### `VCS.json` | ||
|
|
||
| File containing info about version control system used in your package.\ | ||
| Currently only git is supported. |
There was a problem hiding this comment.
| Currently only git is supported. | |
| Currently only Git is supported. |
There was a problem hiding this comment.
Please put each sentence in a separate line. This makes diffs in markdown files significantly better because people mostly operate on sentence level when writing prose, while diff works line-by-line.
| @@ -0,0 +1,7 @@ | |||
| # Overview | |||
|
|
|||
| Scarb is not only a Cairo build toolchain but also a package manager, so it needs support for package storage. Currently, Git is the default for hosting community packages, but their visibility and ease of discovery are greatly limited. That's what registries are for, to have a concentration of packages in one place that are easily discoverable. | |||
There was a problem hiding this comment.
Documentation should focus not on what is changing, but on what is state of the art now. Saying that Git is currently the default is unnecessary. At the very moment of publishing these docs, registries will be the default, while Git be the past.
It's a different thing that there is no official registry, but this is a temporary caveat, which should be said as a banner or something in my opinion.
|
|
||
| Although the official Cairo package registry is in active development and not ready for use yet, you can [host your own](/docs/registries/custom-registry) registry or search for and [use](/docs/registries/custom-registry#using-custom-registry) a community-hosted one. | ||
|
|
||
| If you are interested in learning about the packaging and publishing process, you can read about it [here](/docs/registries/packaging). |
There was a problem hiding this comment.
Use internal links. Editors will try to maintain these when moving files etc.
| Use `scarb package` command to create an archive of your package. You can read about package compression algorithm and contents in [Package tarball](/docs/registries/package-tarball) section. | ||
| Basically when you run the command Scarb looks for the source code of your package together with metadata files such as manifest file and put them in an archive in `target/package` directory. | ||
|
|
||
| If you are in a git repository, Scarb will first check if the repo state is clean and error out in case of any changes present in a git working directory. To ignore this check you can use the `--allow-dirty` flag. |
There was a problem hiding this comment.
| If you are in a git repository, Scarb will first check if the repo state is clean and error out in case of any changes present in a git working directory. To ignore this check you can use the `--allow-dirty` flag. | |
| If you are in a Git repository, Scarb will first check if the repo state is clean and error out in case of any changes present in a git working directory. To ignore this check you can use the `--allow-dirty` flag. |
|
|
||
| If you are in a git repository, Scarb will first check if the repo state is clean and error out in case of any changes present in a git working directory. To ignore this check you can use the `--allow-dirty` flag. | ||
|
|
||
| Next step is the package verification. After creating an initial archive, Scarb will attempt to unpack it and compile to check for any corruptions in the packaging process. If you want to speed up the package process you can disable this step using the `--no-verify` flag. |
There was a problem hiding this comment.
Consider emphasizing that this is a dangerous operation because you never know
|
We will probably want to merge this after the registry MVP is released |
Resolves #734 and #901.