From 439974564da0b0688e92ccb5db64c55670989463 Mon Sep 17 00:00:00 2001 From: Ryan Bottriell Date: Fri, 26 Jul 2024 09:38:15 -0700 Subject: [PATCH 1/5] Update version for release Signed-off-by: Ryan Bottriell --- .site/spi/.spdev.yaml | 2 +- .site/spi/spk.spec | 4 +- Cargo.lock | 96 +++++++++++++++++++++---------------------- Cargo.toml | 2 +- Makefile.windows | 4 +- spfs.spec | 2 +- spk.spec | 4 +- 7 files changed, 57 insertions(+), 57 deletions(-) diff --git a/.site/spi/.spdev.yaml b/.site/spi/.spdev.yaml index c7cc2ecb16..0d7b11b722 100644 --- a/.site/spi/.spdev.yaml +++ b/.site/spi/.spdev.yaml @@ -1,4 +1,4 @@ -version: 0.40.0 +version: 0.42.0 release_notes: | - convert api module to rust - update to latest spfs diff --git a/.site/spi/spk.spec b/.site/spi/spk.spec index 77734f6ad8..d536a4b809 100644 --- a/.site/spi/spk.spec +++ b/.site/spi/spk.spec @@ -1,5 +1,5 @@ Name: spk -Version: 0.40.0 +Version: 0.42.0 Release: 1 Summary: Package manager and a software runtime for studio environments License: NONE @@ -21,7 +21,7 @@ BuildRequires: spdev >= 0.28.2 Requires: bash Requires: fuse Obsoletes: spfs -Provides: spfs = 0.40.0 +Provides: spfs = 0.42.0 %define debug_package %{nil} diff --git a/Cargo.lock b/Cargo.lock index b767a7fc5f..d66bba89db 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2540,7 +2540,7 @@ dependencies = [ [[package]] name = "progress_bar_derive_macro" -version = "0.40.0" +version = "0.42.0" dependencies = [ "indicatif", "quote", @@ -3435,7 +3435,7 @@ dependencies = [ [[package]] name = "spfs" -version = "0.40.0" +version = "0.42.0" dependencies = [ "arc-swap", "async-compression", @@ -3515,7 +3515,7 @@ dependencies = [ [[package]] name = "spfs-cli-clean" -version = "0.40.0" +version = "0.42.0" dependencies = [ "chrono", "clap 4.5.0", @@ -3531,7 +3531,7 @@ dependencies = [ [[package]] name = "spfs-cli-common" -version = "0.40.0" +version = "0.42.0" dependencies = [ "clap 4.5.0", "libc", @@ -3552,7 +3552,7 @@ dependencies = [ [[package]] name = "spfs-cli-enter" -version = "0.40.0" +version = "0.42.0" dependencies = [ "clap 4.5.0", "miette", @@ -3566,7 +3566,7 @@ dependencies = [ [[package]] name = "spfs-cli-fuse" -version = "0.40.0" +version = "0.42.0" dependencies = [ "clap 4.5.0", "dashmap", @@ -3584,7 +3584,7 @@ dependencies = [ [[package]] name = "spfs-cli-join" -version = "0.40.0" +version = "0.42.0" dependencies = [ "clap 4.5.0", "futures", @@ -3597,7 +3597,7 @@ dependencies = [ [[package]] name = "spfs-cli-main" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-recursion", "chrono", @@ -3631,7 +3631,7 @@ dependencies = [ [[package]] name = "spfs-cli-monitor" -version = "0.40.0" +version = "0.42.0" dependencies = [ "clap 4.5.0", "miette", @@ -3645,7 +3645,7 @@ dependencies = [ [[package]] name = "spfs-cli-render" -version = "0.40.0" +version = "0.42.0" dependencies = [ "clap 4.5.0", "dunce", @@ -3661,7 +3661,7 @@ dependencies = [ [[package]] name = "spfs-cli-winfsp" -version = "0.40.0" +version = "0.42.0" dependencies = [ "clap 4.5.0", "dashmap", @@ -3683,7 +3683,7 @@ dependencies = [ [[package]] name = "spfs-encoding" -version = "0.40.0" +version = "0.42.0" dependencies = [ "data-encoding", "miette", @@ -3697,7 +3697,7 @@ dependencies = [ [[package]] name = "spfs-proto" -version = "0.40.0" +version = "0.42.0" dependencies = [ "data-encoding", "flatbuffers", @@ -3712,7 +3712,7 @@ dependencies = [ [[package]] name = "spfs-vfs" -version = "0.40.0" +version = "0.42.0" dependencies = [ "bytes", "clap 4.5.0", @@ -3744,7 +3744,7 @@ checksum = "6980e8d7511241f8acf4aebddbb1ff938df5eebe98691418c4468d0b72a96a67" [[package]] name = "spk" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -3783,7 +3783,7 @@ dependencies = [ [[package]] name = "spk-build" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "dunce", @@ -3811,7 +3811,7 @@ dependencies = [ [[package]] name = "spk-cli-common" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -3846,7 +3846,7 @@ dependencies = [ [[package]] name = "spk-cli-group1" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -3873,7 +3873,7 @@ dependencies = [ [[package]] name = "spk-cli-group2" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -3898,7 +3898,7 @@ dependencies = [ [[package]] name = "spk-cli-group3" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -3919,7 +3919,7 @@ dependencies = [ [[package]] name = "spk-cli-group4" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -3943,7 +3943,7 @@ dependencies = [ [[package]] name = "spk-cmd-build" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -3961,7 +3961,7 @@ dependencies = [ [[package]] name = "spk-cmd-convert" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -3973,7 +3973,7 @@ dependencies = [ [[package]] name = "spk-cmd-debug" -version = "0.40.0" +version = "0.42.0" dependencies = [ "anyhow", "async-trait", @@ -3991,7 +3991,7 @@ dependencies = [ [[package]] name = "spk-cmd-du" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-stream", "async-trait", @@ -4012,7 +4012,7 @@ dependencies = [ [[package]] name = "spk-cmd-env" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -4029,7 +4029,7 @@ dependencies = [ [[package]] name = "spk-cmd-explain" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -4042,7 +4042,7 @@ dependencies = [ [[package]] name = "spk-cmd-install" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -4057,7 +4057,7 @@ dependencies = [ [[package]] name = "spk-cmd-make-binary" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -4077,7 +4077,7 @@ dependencies = [ [[package]] name = "spk-cmd-make-recipe" -version = "0.40.0" +version = "0.42.0" dependencies = [ "anyhow", "async-trait", @@ -4091,7 +4091,7 @@ dependencies = [ [[package]] name = "spk-cmd-make-source" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -4106,7 +4106,7 @@ dependencies = [ [[package]] name = "spk-cmd-render" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -4122,7 +4122,7 @@ dependencies = [ [[package]] name = "spk-cmd-repo" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -4134,7 +4134,7 @@ dependencies = [ [[package]] name = "spk-cmd-test" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "clap 4.5.0", @@ -4155,7 +4155,7 @@ dependencies = [ [[package]] name = "spk-config" -version = "0.40.0" +version = "0.42.0" dependencies = [ "config", "dirs", @@ -4172,7 +4172,7 @@ dependencies = [ [[package]] name = "spk-exec" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-stream", "clap 4.5.0", @@ -4196,7 +4196,7 @@ dependencies = [ [[package]] name = "spk-launcher" -version = "0.40.0" +version = "0.42.0" dependencies = [ "miette", "nix", @@ -4207,7 +4207,7 @@ dependencies = [ [[package]] name = "spk-schema" -version = "0.40.0" +version = "0.42.0" dependencies = [ "data-encoding", "dunce", @@ -4241,7 +4241,7 @@ dependencies = [ [[package]] name = "spk-schema-foundation" -version = "0.40.0" +version = "0.42.0" dependencies = [ "arc-swap", "colored", @@ -4274,7 +4274,7 @@ dependencies = [ [[package]] name = "spk-schema-ident" -version = "0.40.0" +version = "0.42.0" dependencies = [ "colored", "data-encoding", @@ -4294,7 +4294,7 @@ dependencies = [ [[package]] name = "spk-schema-tera" -version = "0.40.0" +version = "0.42.0" dependencies = [ "miette", "once_cell", @@ -4310,7 +4310,7 @@ dependencies = [ [[package]] name = "spk-solve" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-recursion", "async-stream", @@ -4349,7 +4349,7 @@ dependencies = [ [[package]] name = "spk-solve-graph" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-recursion", "async-stream", @@ -4378,7 +4378,7 @@ dependencies = [ [[package]] name = "spk-solve-macros" -version = "0.40.0" +version = "0.42.0" dependencies = [ "serde_json", "spfs", @@ -4387,7 +4387,7 @@ dependencies = [ [[package]] name = "spk-solve-package-iterator" -version = "0.40.0" +version = "0.42.0" dependencies = [ "async-trait", "dyn-clone", @@ -4409,7 +4409,7 @@ dependencies = [ [[package]] name = "spk-solve-solution" -version = "0.40.0" +version = "0.42.0" dependencies = [ "colored", "console", @@ -4424,7 +4424,7 @@ dependencies = [ [[package]] name = "spk-solve-validation" -version = "0.40.0" +version = "0.42.0" dependencies = [ "colored", "dashmap", @@ -4448,7 +4448,7 @@ dependencies = [ [[package]] name = "spk-storage" -version = "0.40.0" +version = "0.42.0" dependencies = [ "arc-swap", "async-trait", diff --git a/Cargo.toml b/Cargo.toml index aa127278a0..a8f832b3f7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -31,7 +31,7 @@ authors = [ "Nichol Yip ", ] edition = "2021" -version = "0.40.0" +version = "0.42.0" [workspace.dependencies] arc-swap = "1.6.0" diff --git a/Makefile.windows b/Makefile.windows index 67de0b6efe..ca9cf4ad88 100644 --- a/Makefile.windows +++ b/Makefile.windows @@ -1,6 +1,6 @@ SHELL := cmd -SPK_VERSION = 0.40.0 -SPFS_VERSION = 0.40.0 +SPK_VERSION = 0.42.0 +SPFS_VERSION = 0.42.0 SOURCE_ROOT := $(subst /,\,$(SOURCE_ROOT)) CARGO_TARGET_DIR := $(SOURCE_ROOT)\target diff --git a/spfs.spec b/spfs.spec index 383ec9bc2d..8eaeb09a80 100644 --- a/spfs.spec +++ b/spfs.spec @@ -1,5 +1,5 @@ Name: spfs -Version: 0.40.0 +Version: 0.42.0 Release: 1%{?dist} Summary: Filesystem isolation, capture, and distribution. License: NONE diff --git a/spk.spec b/spk.spec index 8641a7c595..64ed6331fd 100644 --- a/spk.spec +++ b/spk.spec @@ -1,5 +1,5 @@ Name: spk -Version: 0.40.0 +Version: 0.42.0 Release: 1%{?dist} Summary: Package manager and a software runtime for studio environments License: NONE @@ -26,7 +26,7 @@ Requires: bash Requires: fuse3 Requires: rsync Obsoletes: spfs -Provides: spfs = 0.40.0 +Provides: spfs = 0.42.0 %define debug_package %{nil} From 089cacf6d28a84628fa1f353f5ff739d2fc0b6d3 Mon Sep 17 00:00:00 2001 From: Ryan Bottriell Date: Fri, 26 Jul 2024 09:45:47 -0700 Subject: [PATCH 2/5] Add metadata fields for cargo publishing Signed-off-by: Ryan Bottriell --- Cargo.toml | 6 ++++++ README.md | 2 +- crates/progress_bar_derive_macro/Cargo.toml | 5 +++++ crates/spfs-cli/cmd-clean/Cargo.toml | 5 +++++ crates/spfs-cli/cmd-enter/Cargo.toml | 5 +++++ crates/spfs-cli/cmd-fuse/Cargo.toml | 5 +++++ crates/spfs-cli/cmd-join/Cargo.toml | 5 +++++ crates/spfs-cli/cmd-monitor/Cargo.toml | 5 +++++ crates/spfs-cli/cmd-render/Cargo.toml | 5 +++++ crates/spfs-cli/cmd-winfsp/Cargo.toml | 5 +++++ crates/spfs-cli/common/Cargo.toml | 5 +++++ crates/spfs-cli/main/Cargo.toml | 5 +++++ crates/spfs-encoding/Cargo.toml | 5 +++++ crates/spfs-proto/Cargo.toml | 5 +++++ crates/spfs-vfs/Cargo.toml | 5 +++++ crates/spfs/Cargo.toml | 5 +++++ crates/spk-build/Cargo.toml | 5 +++++ crates/spk-cli/cmd-build/Cargo.toml | 5 +++++ crates/spk-cli/cmd-convert/Cargo.toml | 5 +++++ crates/spk-cli/cmd-debug/Cargo.toml | 5 +++++ crates/spk-cli/cmd-du/Cargo.toml | 5 +++++ crates/spk-cli/cmd-env/Cargo.toml | 5 +++++ crates/spk-cli/cmd-explain/Cargo.toml | 5 +++++ crates/spk-cli/cmd-install/Cargo.toml | 5 +++++ crates/spk-cli/cmd-make-binary/Cargo.toml | 5 +++++ crates/spk-cli/cmd-make-recipe/Cargo.toml | 5 +++++ crates/spk-cli/cmd-make-source/Cargo.toml | 5 +++++ crates/spk-cli/cmd-render/Cargo.toml | 5 +++++ crates/spk-cli/cmd-repo/Cargo.toml | 5 +++++ crates/spk-cli/cmd-test/Cargo.toml | 5 +++++ crates/spk-cli/common/Cargo.toml | 5 +++++ crates/spk-cli/group1/Cargo.toml | 5 +++++ crates/spk-cli/group2/Cargo.toml | 5 +++++ crates/spk-cli/group3/Cargo.toml | 5 +++++ crates/spk-cli/group4/Cargo.toml | 5 +++++ crates/spk-config/Cargo.toml | 5 +++++ crates/spk-exec/Cargo.toml | 5 +++++ crates/spk-launcher/Cargo.toml | 5 +++++ crates/spk-schema/Cargo.toml | 5 +++++ crates/spk-schema/crates/foundation/Cargo.toml | 5 +++++ crates/spk-schema/crates/ident/Cargo.toml | 5 +++++ crates/spk-schema/crates/tera/Cargo.toml | 5 +++++ crates/spk-solve/Cargo.toml | 5 +++++ crates/spk-solve/crates/graph/Cargo.toml | 5 +++++ crates/spk-solve/crates/macros/Cargo.toml | 5 +++++ crates/spk-solve/crates/package-iterator/Cargo.toml | 5 +++++ crates/spk-solve/crates/solution/Cargo.toml | 5 +++++ crates/spk-solve/crates/validation/Cargo.toml | 5 +++++ crates/spk-storage/Cargo.toml | 5 +++++ crates/spk/Cargo.toml | 5 +++++ 50 files changed, 247 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index a8f832b3f7..e8e08e2b3f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -32,6 +32,12 @@ authors = [ ] edition = "2021" version = "0.42.0" +license-file = "LICENSE" +homepage = "https://spkenv.dev" +repository = "https://github.com/spkenv/spk" +readme = "README.md" +description = "SPK is a Package Manager for high-velocity software environments, built on SPFS. SPFS is a system for filesystem isolation, capture, and distribution." + [workspace.dependencies] arc-swap = "1.6.0" diff --git a/README.md b/README.md index a9921b2c0c..8a0fd35950 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ alt="SPK Logo" src="website/static/images/spk_white.png#gh-dark-mode-only"/> [![Docs Badge](https://img.shields.io/badge/docs-passing-green.svg)](https://spkenv.dev) -- **SPK** - A Package Manager for high velocity software environments, built on spfs. +- **SPK** - A Package Manager for high-velocity software environments, built on SPFS. - **SPFS** - Filesystem isolation, capture, and distribution. --- diff --git a/crates/progress_bar_derive_macro/Cargo.toml b/crates/progress_bar_derive_macro/Cargo.toml index 6e8b216b62..aeb68c495f 100644 --- a/crates/progress_bar_derive_macro/Cargo.toml +++ b/crates/progress_bar_derive_macro/Cargo.toml @@ -1,6 +1,11 @@ [package] name = "progress_bar_derive_macro" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } edition = { workspace = true } [lints] diff --git a/crates/spfs-cli/cmd-clean/Cargo.toml b/crates/spfs-cli/cmd-clean/Cargo.toml index 3cd4e67de4..6d57581ed9 100644 --- a/crates/spfs-cli/cmd-clean/Cargo.toml +++ b/crates/spfs-cli/cmd-clean/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-cli-clean" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-cli/cmd-enter/Cargo.toml b/crates/spfs-cli/cmd-enter/Cargo.toml index f0d083d917..d38b551930 100644 --- a/crates/spfs-cli/cmd-enter/Cargo.toml +++ b/crates/spfs-cli/cmd-enter/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-cli-enter" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-cli/cmd-fuse/Cargo.toml b/crates/spfs-cli/cmd-fuse/Cargo.toml index 8d597bbe95..63be0dab0e 100644 --- a/crates/spfs-cli/cmd-fuse/Cargo.toml +++ b/crates/spfs-cli/cmd-fuse/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-cli-fuse" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-cli/cmd-join/Cargo.toml b/crates/spfs-cli/cmd-join/Cargo.toml index be9f8f0d0e..1988ed5693 100644 --- a/crates/spfs-cli/cmd-join/Cargo.toml +++ b/crates/spfs-cli/cmd-join/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-cli-join" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-cli/cmd-monitor/Cargo.toml b/crates/spfs-cli/cmd-monitor/Cargo.toml index 62f374417d..834bf3740a 100644 --- a/crates/spfs-cli/cmd-monitor/Cargo.toml +++ b/crates/spfs-cli/cmd-monitor/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-cli-monitor" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-cli/cmd-render/Cargo.toml b/crates/spfs-cli/cmd-render/Cargo.toml index b464cc3246..b424df4117 100644 --- a/crates/spfs-cli/cmd-render/Cargo.toml +++ b/crates/spfs-cli/cmd-render/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-cli-render" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-cli/cmd-winfsp/Cargo.toml b/crates/spfs-cli/cmd-winfsp/Cargo.toml index d295644536..6bb4115697 100644 --- a/crates/spfs-cli/cmd-winfsp/Cargo.toml +++ b/crates/spfs-cli/cmd-winfsp/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-cli-winfsp" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-cli/common/Cargo.toml b/crates/spfs-cli/common/Cargo.toml index 1b90c657c8..4ec785ede8 100644 --- a/crates/spfs-cli/common/Cargo.toml +++ b/crates/spfs-cli/common/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-cli-common" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-cli/main/Cargo.toml b/crates/spfs-cli/main/Cargo.toml index 0727733454..dc30e12435 100644 --- a/crates/spfs-cli/main/Cargo.toml +++ b/crates/spfs-cli/main/Cargo.toml @@ -4,6 +4,11 @@ default-run = "spfs" edition = { workspace = true } name = "spfs-cli-main" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-encoding/Cargo.toml b/crates/spfs-encoding/Cargo.toml index c1ac7419f4..13f31d15d0 100644 --- a/crates/spfs-encoding/Cargo.toml +++ b/crates/spfs-encoding/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-encoding" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-proto/Cargo.toml b/crates/spfs-proto/Cargo.toml index 992ec17b16..b8e78b36c9 100644 --- a/crates/spfs-proto/Cargo.toml +++ b/crates/spfs-proto/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-proto" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs-vfs/Cargo.toml b/crates/spfs-vfs/Cargo.toml index 0ecf2014df..028e6b2965 100644 --- a/crates/spfs-vfs/Cargo.toml +++ b/crates/spfs-vfs/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs-vfs" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spfs/Cargo.toml b/crates/spfs/Cargo.toml index c733223a8f..b93c183a8d 100644 --- a/crates/spfs/Cargo.toml +++ b/crates/spfs/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spfs" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-build/Cargo.toml b/crates/spk-build/Cargo.toml index 8b7fd79f1f..74c82fc034 100644 --- a/crates/spk-build/Cargo.toml +++ b/crates/spk-build/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-build" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-build/Cargo.toml b/crates/spk-cli/cmd-build/Cargo.toml index 8e2fb81d6a..6b9d926972 100644 --- a/crates/spk-cli/cmd-build/Cargo.toml +++ b/crates/spk-cli/cmd-build/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-build" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-convert/Cargo.toml b/crates/spk-cli/cmd-convert/Cargo.toml index 204957d90f..9a07bbd556 100644 --- a/crates/spk-cli/cmd-convert/Cargo.toml +++ b/crates/spk-cli/cmd-convert/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-convert" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-debug/Cargo.toml b/crates/spk-cli/cmd-debug/Cargo.toml index 9dd916cef9..daf71df124 100644 --- a/crates/spk-cli/cmd-debug/Cargo.toml +++ b/crates/spk-cli/cmd-debug/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-debug" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-du/Cargo.toml b/crates/spk-cli/cmd-du/Cargo.toml index dbbaeb7c60..0e417337bc 100644 --- a/crates/spk-cli/cmd-du/Cargo.toml +++ b/crates/spk-cli/cmd-du/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-du" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-env/Cargo.toml b/crates/spk-cli/cmd-env/Cargo.toml index 07e0f2c253..885ad5643d 100644 --- a/crates/spk-cli/cmd-env/Cargo.toml +++ b/crates/spk-cli/cmd-env/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-env" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-explain/Cargo.toml b/crates/spk-cli/cmd-explain/Cargo.toml index e28d98b2ef..7522bacb99 100644 --- a/crates/spk-cli/cmd-explain/Cargo.toml +++ b/crates/spk-cli/cmd-explain/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-explain" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-install/Cargo.toml b/crates/spk-cli/cmd-install/Cargo.toml index bea445d115..5d63928b26 100644 --- a/crates/spk-cli/cmd-install/Cargo.toml +++ b/crates/spk-cli/cmd-install/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-install" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-make-binary/Cargo.toml b/crates/spk-cli/cmd-make-binary/Cargo.toml index 21a31afa23..5e823eadeb 100644 --- a/crates/spk-cli/cmd-make-binary/Cargo.toml +++ b/crates/spk-cli/cmd-make-binary/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-make-binary" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-make-recipe/Cargo.toml b/crates/spk-cli/cmd-make-recipe/Cargo.toml index feb3eb16c6..f13b3d4738 100644 --- a/crates/spk-cli/cmd-make-recipe/Cargo.toml +++ b/crates/spk-cli/cmd-make-recipe/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-make-recipe" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-make-source/Cargo.toml b/crates/spk-cli/cmd-make-source/Cargo.toml index 7f747953d4..702ce38687 100644 --- a/crates/spk-cli/cmd-make-source/Cargo.toml +++ b/crates/spk-cli/cmd-make-source/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-make-source" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-render/Cargo.toml b/crates/spk-cli/cmd-render/Cargo.toml index b5dcfc0304..30f14179bd 100644 --- a/crates/spk-cli/cmd-render/Cargo.toml +++ b/crates/spk-cli/cmd-render/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-render" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-repo/Cargo.toml b/crates/spk-cli/cmd-repo/Cargo.toml index 4d52959264..74aef594c4 100644 --- a/crates/spk-cli/cmd-repo/Cargo.toml +++ b/crates/spk-cli/cmd-repo/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-repo" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/cmd-test/Cargo.toml b/crates/spk-cli/cmd-test/Cargo.toml index a0fbdd997b..b608169951 100644 --- a/crates/spk-cli/cmd-test/Cargo.toml +++ b/crates/spk-cli/cmd-test/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cmd-test" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/common/Cargo.toml b/crates/spk-cli/common/Cargo.toml index 1fa600a984..a9cdb674b7 100644 --- a/crates/spk-cli/common/Cargo.toml +++ b/crates/spk-cli/common/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cli-common" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/group1/Cargo.toml b/crates/spk-cli/group1/Cargo.toml index d33acd918e..822834a9fb 100644 --- a/crates/spk-cli/group1/Cargo.toml +++ b/crates/spk-cli/group1/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cli-group1" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/group2/Cargo.toml b/crates/spk-cli/group2/Cargo.toml index bb84123250..bf81c3cccc 100644 --- a/crates/spk-cli/group2/Cargo.toml +++ b/crates/spk-cli/group2/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cli-group2" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/group3/Cargo.toml b/crates/spk-cli/group3/Cargo.toml index b67d2a3f36..267687f1bf 100644 --- a/crates/spk-cli/group3/Cargo.toml +++ b/crates/spk-cli/group3/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cli-group3" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-cli/group4/Cargo.toml b/crates/spk-cli/group4/Cargo.toml index ebcdba53c1..0663a73f98 100644 --- a/crates/spk-cli/group4/Cargo.toml +++ b/crates/spk-cli/group4/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-cli-group4" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-config/Cargo.toml b/crates/spk-config/Cargo.toml index 691234f565..dc5811078f 100644 --- a/crates/spk-config/Cargo.toml +++ b/crates/spk-config/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } name = "spk-config" edition = { workspace = true } version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-exec/Cargo.toml b/crates/spk-exec/Cargo.toml index 3ca801684b..6c838136cd 100644 --- a/crates/spk-exec/Cargo.toml +++ b/crates/spk-exec/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-exec" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-launcher/Cargo.toml b/crates/spk-launcher/Cargo.toml index b067905339..2d4df99779 100644 --- a/crates/spk-launcher/Cargo.toml +++ b/crates/spk-launcher/Cargo.toml @@ -2,6 +2,11 @@ authors = { workspace = true } name = "spk-launcher" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } edition = { workspace = true } [lints] diff --git a/crates/spk-schema/Cargo.toml b/crates/spk-schema/Cargo.toml index f0cf9489a3..9f7f77ca44 100644 --- a/crates/spk-schema/Cargo.toml +++ b/crates/spk-schema/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-schema" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-schema/crates/foundation/Cargo.toml b/crates/spk-schema/crates/foundation/Cargo.toml index 2a8f8aad8b..6f81a43011 100644 --- a/crates/spk-schema/crates/foundation/Cargo.toml +++ b/crates/spk-schema/crates/foundation/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-schema-foundation" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-schema/crates/ident/Cargo.toml b/crates/spk-schema/crates/ident/Cargo.toml index e4a9b57a3b..913c81911e 100644 --- a/crates/spk-schema/crates/ident/Cargo.toml +++ b/crates/spk-schema/crates/ident/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-schema-ident" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-schema/crates/tera/Cargo.toml b/crates/spk-schema/crates/tera/Cargo.toml index 2c0022bf90..0426fbf269 100644 --- a/crates/spk-schema/crates/tera/Cargo.toml +++ b/crates/spk-schema/crates/tera/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-schema-tera" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-solve/Cargo.toml b/crates/spk-solve/Cargo.toml index 2e8ae9166b..0e0d1a5eb8 100644 --- a/crates/spk-solve/Cargo.toml +++ b/crates/spk-solve/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-solve" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-solve/crates/graph/Cargo.toml b/crates/spk-solve/crates/graph/Cargo.toml index 3dbc2541d5..ee65155067 100644 --- a/crates/spk-solve/crates/graph/Cargo.toml +++ b/crates/spk-solve/crates/graph/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-solve-graph" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-solve/crates/macros/Cargo.toml b/crates/spk-solve/crates/macros/Cargo.toml index a333222169..e50759396a 100644 --- a/crates/spk-solve/crates/macros/Cargo.toml +++ b/crates/spk-solve/crates/macros/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-solve-macros" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-solve/crates/package-iterator/Cargo.toml b/crates/spk-solve/crates/package-iterator/Cargo.toml index 94c55e8ea4..8ec18ec3e5 100644 --- a/crates/spk-solve/crates/package-iterator/Cargo.toml +++ b/crates/spk-solve/crates/package-iterator/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-solve-package-iterator" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-solve/crates/solution/Cargo.toml b/crates/spk-solve/crates/solution/Cargo.toml index d58a5019cd..84a2e31d51 100644 --- a/crates/spk-solve/crates/solution/Cargo.toml +++ b/crates/spk-solve/crates/solution/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-solve-solution" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-solve/crates/validation/Cargo.toml b/crates/spk-solve/crates/validation/Cargo.toml index b36e0d2299..9b46e69d41 100644 --- a/crates/spk-solve/crates/validation/Cargo.toml +++ b/crates/spk-solve/crates/validation/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-solve-validation" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk-storage/Cargo.toml b/crates/spk-storage/Cargo.toml index 5edb1bbd10..2da871ad4a 100644 --- a/crates/spk-storage/Cargo.toml +++ b/crates/spk-storage/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk-storage" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } [lints] workspace = true diff --git a/crates/spk/Cargo.toml b/crates/spk/Cargo.toml index f148e30af6..b39b7aac0d 100644 --- a/crates/spk/Cargo.toml +++ b/crates/spk/Cargo.toml @@ -3,6 +3,11 @@ authors = { workspace = true } edition = { workspace = true } name = "spk" version = { workspace = true } +license-file = { workspace = true } +homepage = { workspace = true } +repository = { workspace = true } +readme = { workspace = true } +description = { workspace = true } default-run = "spk" [lints] From c8219a6c4a3c8664f0cae2bc30e39d7e6f155fc9 Mon Sep 17 00:00:00 2001 From: Ryan Bottriell Date: Fri, 26 Jul 2024 09:49:01 -0700 Subject: [PATCH 3/5] Remove markdown extension from license text file Signed-off-by: Ryan Bottriell --- LICENSE.md => LICENSE | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename LICENSE.md => LICENSE (100%) diff --git a/LICENSE.md b/LICENSE similarity index 100% rename from LICENSE.md rename to LICENSE From 60a30110bf6ec7b01d7a80b5ca28ef0096bb09d2 Mon Sep 17 00:00:00 2001 From: Ryan Bottriell Date: Fri, 26 Jul 2024 10:41:26 -0700 Subject: [PATCH 4/5] Add repository link to main github page Signed-off-by: Ryan Bottriell --- docs/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_index.md b/docs/_index.md index 912e449720..8e77b0e208 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -9,7 +9,7 @@ alt="SPK Logo" src="/images/spk_black.png"/> The **S**oftware **P**ackaging **K**it (SPK) provides package management and a software runtime for studio environments. -
{{% button href="./use" %}}Getting Started{{% /button %}} {{% button href="./ref/spec" %}}Yaml Reference{{% /button %}} {{% button href="./error_codes" %}}Error Codes{{% /button %}}
+
{{% button href="./use" %}}Getting Started{{% /button %}} {{% button href="./ref/spec" %}}Yaml Reference{{% /button %}} {{% button href="./error_codes" %}}Error Codes{{% /button %}} {{% button href="https://github.com/spkenv/spk" %}}GitHub{{% /button %}}
Driven by the unique requirements of the film, vfx, and animation industries, SPK has a few primary goals: From ebe115f20718f38c6a39f90f95dffbf5b1af89bc Mon Sep 17 00:00:00 2001 From: Ryan Bottriell Date: Fri, 26 Jul 2024 18:18:36 -0700 Subject: [PATCH 5/5] Remove old docs and clarify the state of things in the readme Signed-off-by: Ryan Bottriell --- OPEN_SOURCE_PLAN.md | 83 --------------------------------------------- README.md | 50 +++++++++++++-------------- 2 files changed, 23 insertions(+), 110 deletions(-) delete mode 100644 OPEN_SOURCE_PLAN.md diff --git a/OPEN_SOURCE_PLAN.md b/OPEN_SOURCE_PLAN.md deleted file mode 100644 index 7892fad5c0..0000000000 --- a/OPEN_SOURCE_PLAN.md +++ /dev/null @@ -1,83 +0,0 @@ - - - - -# Open Source Execution Plan for SPK et al. - -This is our working plan for how to turn this into a fully public, -community-developed and widely used project. - -Contributors should propose edits to this, add milestones or tasks I have -forgotten, and check off items as they are completed. We'll only keep this -document alive as long as it is useful to us. - -## Before any sharing - -There are some housekeeping tasks to perform to the code base before anyone -outside Imageworks can have access to it: - -- [x] Set up external (but private) repos, add internal developers. -- [x] Set up email list, add internal developers. -- [x] The code needs a LICENSE file attached, and copyright notices affixed - to all the code modules. -- [x] README, CONTRIBUTING guide, basic procedures, etc. -- the set of - things expected for any open source project. -- [x] Some work to make it buildable and testable, so that the initial - co-developers will actually be able to kick the tires. -- [x] If possible, set up initial continuous integration so we know it - builds outside of our environment and can pass basic tests. -- [x] Get **final** business clearance to open source. -- [x] Add external developers to mail list, GitHub repos. - - -## Initial private share to work toward minimal viable product - -The code is not currently ready to let just anybody use it -- it lacks a -simple way to build it outside our environment, needs documentation, comes -with no build/packaging recipes, etc. We don't want to go "public" until -it's in shape that it will make a good first impression and be useful for -people to start using. - -We propose to host it on GitHub in the Imageworks area, but as private -repositories that are only visible with per-user permissions. We will -initially invite the other people who have expressed interest in helping us -to co-develop the software moving forward. As we start to talk more publicly -about what we're working on, we can also invite anyone else who subsequently -expresses an interest in helping with the process. - -The purpose of this privately shared period is get to a "MVP" state, which -involves at least the following: - -- [x] Let the other presumed contributors see the code for the first time, try it out, evaluate it, figure out which parts need alteration to suit their needs, and which parts of the project moving forward they would like to help with. -- [x] Set up a regular stakeholder meeting cadence. -- [ ] Combine the (currently) three repositories (for the file system layer, the packager, and the application launcher) into a single project/repository. -- [x] Make sure that it's easily buildable and deployable outside the SPI environment, including build/deploy documentation. -- [x] Set up a continuous integration system that can build and test the system, using GitHub Actions. -- [ ] Figure out how to organize package recipes within the repository, and seed it with package recipes for all the common VFX packages so that it will be a useful working system "out of the box" when it goes truly public. -- [ ] Set up web site and online documentation. -- [ ] Need logo and other basic graphic design assets. -- [ ] Achieve consensus on project governance -- who chairs meetings, how do we reach decisions, is there a chief architect with final call on technical disputes, how are people added to steering committee, etc. -- [ ] Anything else, technical or organizational, that comes up or is identified by the co-developers, that we think needs to be fixed before it's ready to be public. - - -## Public share - -When the stakeholders think that the project is ready to launch publicly, we can just switch the existing repository from "private" to "public." We'll probably want some announcement or PR at that time. - - -## Possible ASWF future - -It certainly seems like an ideal project to turn over to the ASWF. It is hard to determine the best timeline for this at this point, particularly before the other co-developers have been fully identified and before any of them have had a chance to see the project in action. - -It may be that the right approach is to continue hosting it in the Imageworks GitHub account until it reaches a maturity level that the stakeholders decide they want to apply to turn it over to the ASWF. It is also possible that soon after the stakeholders see it and start working, they will desire to have it hosted in a truly neutral place like the ASWF as soon as possible, as a way to provide an even better foundation upon which many parties can collaborate. We will see how it goes and collectively decide when the time is right to try to have it hosted at ASWF. - - -## Proposed Timeline - -This is all subject to change; this is just a stake in the ground to -document a possible future. - -- Immediately: Set up private repos (without sharing with anyone outside), start working on the "pre-share" tasks listed above. -- By the end of next week (Apr 23), if possible: invite the outside stakeholders to have read permissions on the private repository. -- SIGGRAPH might be a good goal for a "go public" date and formal announcement about the project. The actual date for switching the repo to public visibility might be somewhat before or somewhat after, depending on how quickly we can accomplish the "private share" tasks. -- TBD when the right time is to apply for ASWF governance of the project, we'll have to see how the other steps go. diff --git a/README.md b/README.md index 8a0fd35950..42b95be461 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,10 @@ See the main [docs](docs/) for details on using spk, starting with the [index](d ## License -SPK/SPFS/spawn are Copyright (c) Contributors to the SPK project. +SPK/SPFS are Copyright (c) Contributors to the SPK project. All Rights Reserved. -SPK/SPFS/spawn are distributed using the [Apache-2.0 license](LICENSE.txt). +SPK/SPFS are distributed using the [Apache-2.0 license](LICENSE.txt). ## Structure of this project @@ -37,26 +37,13 @@ SPK/SPFS/spawn are distributed using the [Apache-2.0 license](LICENSE.txt). `spk` is the software packaging system built on top of SPFS. -`spawn` is the application launcher for spk packages. - -These are spread over two code bases at the moment, but may -be merged into a single project, [spk](https://github.com/spkenv/spk). -Please refer to [spk](https://github.com/spkenv/spk) for almost all -information about staging the open source project, that's where the -developer documentation and communication will live, including -[Contributing to SPK](https://github.com/spkenv/spk/CONTRIBUTING.md). - ## Contributing Please read [Contributing to SPK](https://github.com/spkenv/spk/CONTRIBUTING.md). -## Development plan - -Please read [SPK open source development plan](https://github.com/spkenv/spk/OPEN_SOURCE_PLAN.md). - ## Development -Both spk and spfs are written in Rust and use cargo. The best way to get started with rust development is to install the latest stable rust toolchain using [rustup](https://rustup.sh). +Both SPK and SPFS are written in Rust and use cargo. The best way to get started with Rust development is to install the latest stable Rust toolchain using [rustup](https://rustup.sh). For details on architecture and design of the codebase, see the [developer docs](docs/develop). @@ -83,7 +70,7 @@ make install ### RPM Package -The codebase is setup to produce a centos7-compatible rpm package for both spfs and spk by building them in a docker container. To create the rpm package, you will need docker installed. These packages are also built and made available in this repository's CI. +The codebase is set up to produce a centos7-compatible rpm package for both spfs and spk by building them in a docker container. To create the rpm package, you will need docker installed. These packages are also built and made available in this repository's CI. ```sh # build the rpm package via docker and copy into ./dist/rpm @@ -92,7 +79,7 @@ make rpms ### Testing -Both projecs have a number of unit and integration tests as well as testable examples that can all be executed with `make test`. The tests for spk need to be executed under an spfs runtime in order to properly execute. We also have configured linting rules that must pass for all contributions. +Both projects have a number of unit and integration tests as well as testable examples that can all be executed with `make test`. The tests for spk need to be executed under an SPFS runtime in order to properly execute. We also have configured linting rules that must pass for all contributions. Our repository is broken down into a number of smaller crates for easier development, and they can be individually targeted in the makefile which can greatly reduce the time it takes for testing and linting. @@ -108,6 +95,10 @@ make lint test CRATES=spfs-encoding,spfs-cli-common ### Bootstrapping +> [!WARNING] +> The existing bootstrapping setup was developed for CentOS 7 and may need +> updates as we transition to el9 distributions. + In a new environment, it can be helpful to build all of the core packages whose recipes ship with SPK. A script has been provided which runs through all of the builds for these packages in the right order. ```sh @@ -123,6 +114,10 @@ Some of these package specs have not yet been used or tested fully or ironed out #### Using Docker +> [!WARNING] +> The this process was setup to create packages in CentOS 7 and may need +> updates as we transition to el9 distributions. + Currently, this process can only be run on an rpm-based system, as it relies on some rpm packages being installed on the host in order to bootstrap the build process. If you are not running on an rpm-based system, you can run the process in a container instead: ```sh @@ -137,7 +132,7 @@ make packages.import #### Conversion Packages -Spk has logic to automatically convert pip packages to spk packages for easy python environment creation. This logic lives and runs inside of it's own spk package/environment. If you have python3 already installed, you can generate this package locally like so: +Spk has logic to automatically convert pip packages to spk packages for easy Python environment creation. This logic lives and runs inside of its own spk package/environment. If you have python3 already installed, you can generate this package locally like so: ```sh make converters @@ -153,10 +148,10 @@ spk convert pip --help #### Other Notes -- The make `packages.python2` and `packages.python3` targets can be used to bootstrap just enough to be able to build python for spk. The python recipes will build multiple python versions for each gcc48 and 63 as well as for the different python abi's +- The `make packages.python3` target can be used to bootstrap just enough to be able to build Python for SPK. The Python recipes will build multiple Python versions for each gcc48 and 63 as well as for the different Python ABIs - The make `packages.gnu` target can be used to bootstrap just enough to get "native" spk packages for gcc48 and gcc63 -Of course, the packages themselves can also be build with the `spk build ` command directly, though you may find that some required build dependencies need to be generated with the `make packages.bootstrap.full` command first. +Of course, the packages themselves can also be built with the `spk build ` command directly, though you may find that some required build dependencies need to be generated with the `make packages.bootstrap.full` command first. The following RPM packages must be installed in order to create the bootstrap packages. @@ -184,13 +179,14 @@ sudo yum install -y \ zip \ zlib ``` -SPFS has a number of unit tests written in rust that can be run using the `cargo` command. + +SPFS has a number of unit tests written in Rust that can be run using the `cargo` command or via our make target. ```sh -cargo test +make test ``` -Additionally, there are a number of integration tests that validate the fully installed state of spfs. These are generally a series of spfs command line calls that validate the creation and usage of the `/spfs` filesystem. +Additionally, there are a number of integration tests that validate the fully installed state of spfs. These are generally a series of SPFS command line calls that validate the creation and usage of the `/spfs` filesystem. ```sh cargo build @@ -200,9 +196,9 @@ tests/integration/run_all.sh ### Windows -To build and run on windows, you need a couple of dependencies that are easiest to install via chocolatey. +To build and run on Windows, you need a couple of dependencies that are easiest to install via Chocolatey. -``` +```sh choco install protoc llvm winfsp ``` @@ -214,7 +210,7 @@ Benchmark tests can be found in `benches/`. All benchmark tests can be run with cargo bench --bench spfs_bench ``` -A common workflow as described [here](https://bheisler.github.io/criterion.rs/book/user_guide/command_line_options.html#baselines) is to record a baseline measurement to use as a reference to compare future measurements to. +A common workflow as described [here](https://bheisler.github.io/criterion.rs/book/user_guide/command_line_options.html#baselines) is to record a baseline measurement to use as a reference to compare future measurements against. ```sh git checkout main