From 80d386471d3810041a202fb3a0cbd13cbb43cd5c Mon Sep 17 00:00:00 2001 From: Adam Perry Date: Thu, 2 Jul 2020 10:48:25 -0700 Subject: [PATCH] [crates.io] Update manifests, add (empty) changelogs. From #147, addresses C-METADATA --- CHANGELOG.md | 3 +++ CONTRIBUTING.md | 8 +++--- Cargo.toml | 14 ++++++++--- dom/CHANGELOG.md | 3 +++ dom/Cargo.toml | 12 ++++++--- dom/README.md | 53 ---------------------------------------- dom/augdom/CHANGELOG.md | 3 +++ dom/augdom/Cargo.toml | 12 ++++++--- dom/raf/CHANGELOG.md | 1 + dom/raf/Cargo.toml | 14 ++++++++--- illicit/CHANGELOG.md | 3 +++ illicit/Cargo.toml | 14 ++++++++--- illicit/macro/Cargo.toml | 12 +++++---- mox/CHANGELOG.md | 3 +++ mox/Cargo.toml | 14 ++++++++--- topo/CHANGELOG.md | 3 +++ topo/Cargo.toml | 14 +++++++---- topo/macro/Cargo.toml | 12 +++++---- 18 files changed, 105 insertions(+), 93 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 dom/CHANGELOG.md delete mode 100644 dom/README.md create mode 100644 dom/augdom/CHANGELOG.md create mode 100644 dom/raf/CHANGELOG.md create mode 100644 illicit/CHANGELOG.md create mode 100644 mox/CHANGELOG.md create mode 100644 topo/CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..2f9295701 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# `moxie` releases + +TODO link to other changelogs \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a5059b060..808a2b9af 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,11 +70,13 @@ connection to listen for changes, reloading when changes occur. During development all non-tool crate versions should be suffixed with `-pre` indicating a pre-release of some kind. To release a version of a crate, publish a commit to `origin/main/HEAD` -without the pre-release suffix. The project's continuous integration ensures that any "release" -versions (without `-pre`) have been published to crates.io. +without the pre-release suffix, making sure to update CHANGELOGs appropriately. The project's +continuous integration ensures that any "release" versions (without `-pre`) have been published to +crates.io. After a release, all version numbers should be incremented and have `-pre` re-appended. PRs are -expected to bump the version number of the crate they're modifying behind the `-pre` suffix. +expected to bump the version number of the crate they're modifying behind the `-pre` suffix as well +as updating the relevant CHANGELOGs. #### New crates diff --git a/Cargo.toml b/Cargo.toml index 8ef92fbb5..bda31f883 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,11 +3,17 @@ cargo-features = ["named-profiles"] # for coverage [package] name = "moxie" version = "0.3.0-pre" -edition = "2018" -authors = ["Adam Perry "] +description = "Incremental runtime for interactive software." +categories = ["asynchronous", "caching", "concurrency", "gui", "rust-patterns"] +keywords = ["incremental", "memoize", "intern", "reactive"] +readme = "CHANGELOG.md" + +# update here, update everywhere! license = "MIT/Apache-2.0" -description = "Declarative, asynchronous, incremental UI runtime." -repository = "https://github.com/anp/moxie" +homepage = "https://moxie.rs" +repository = "https://github.com/anp/moxie.git" +authors = ["Adam Perry "] +edition = "2018" [dependencies] futures = "0.3.5" diff --git a/dom/CHANGELOG.md b/dom/CHANGELOG.md new file mode 100644 index 000000000..be28f2d0a --- /dev/null +++ b/dom/CHANGELOG.md @@ -0,0 +1,3 @@ +# moxie-dom releases + +TODO \ No newline at end of file diff --git a/dom/Cargo.toml b/dom/Cargo.toml index 1dd056889..e141c4ab1 100644 --- a/dom/Cargo.toml +++ b/dom/Cargo.toml @@ -1,11 +1,17 @@ [package] name = "moxie-dom" version = "0.3.0-pre" +description = "Incrementally interactive HTML applications." +categories = ["asynchronous", "concurrency", "gui", "wasm", "web-programming"] +keywords = ["dom", "web", "incremental", "interactive"] +readme = "CHANGELOG.md" + +# update here, update everywhere! +license = "MIT/Apache-2.0" +homepage = "https://moxie.rs" +repository = "https://github.com/anp/moxie.git" authors = ["Adam Perry "] edition = "2018" -license = "MIT/Apache-2.0" -description = "TBA" -repository = "https://github.com/anp/moxie" [package.metadata.docs.rs] default-target = "wasm32-unknown-unknown" diff --git a/dom/README.md b/dom/README.md deleted file mode 100644 index 5fcb76f40..000000000 --- a/dom/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# πŸ¦€πŸ•ΈοΈ `wasm-pack-template` - -A template for kick starting a Rust and WebAssembly project using -[`wasm-pack`](https://github.com/rustwasm/wasm-pack). - -[**πŸ“š Read this template tutorial! πŸ“š**][template-docs] - -This template is designed for compiling Rust libraries into WebAssembly and -publishing the resulting package to NPM. - -Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other -templates and usages of `wasm-pack`. - -[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html -[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html - -## 🚴 Usage - -### πŸ‘ Use `cargo generate` to Clone this Template - -[Learn more about `cargo generate` here.](https://github.com/ashleygwilliams/cargo-generate) - -``` -cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project -cd my-project -``` - -### πŸ› οΈ Build with `wasm-pack build` - -``` -wasm-pack build -``` - -### πŸ”¬ Test in Headless Browsers with `wasm-pack test` - -``` -wasm-pack test --headless --firefox -``` - -### 🎁 Publish to NPM with `wasm-pack publish` - -``` -wasm-pack publish -``` - -## πŸ”‹ Batteries Included - -* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating - between WebAssembly and JavaScript. -* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook) - for logging panic messages to the developer console. -* [`wee_alloc`](https://github.com/rustwasm/wee_alloc), an allocator optimized - for small code size. diff --git a/dom/augdom/CHANGELOG.md b/dom/augdom/CHANGELOG.md new file mode 100644 index 000000000..22936c8b4 --- /dev/null +++ b/dom/augdom/CHANGELOG.md @@ -0,0 +1,3 @@ +# augdom releases + +TODO \ No newline at end of file diff --git a/dom/augdom/Cargo.toml b/dom/augdom/Cargo.toml index a49cef2fe..bc6e9cb31 100644 --- a/dom/augdom/Cargo.toml +++ b/dom/augdom/Cargo.toml @@ -1,11 +1,17 @@ [package] name = "augdom" version = "0.2.0-pre" +description = "DOM API usable both inside of a browser (web-sys) and outside (emulation)." +categories = ["api-bindings", "emulators", "gui", "wasm", "web-programming"] +keywords = ["dom", "incremental"] +readme = "CHANGELOG.md" + +# update here, update everywhere! +license = "MIT/Apache-2.0" +homepage = "https://moxie.rs" +repository = "https://github.com/anp/moxie.git" authors = ["Adam Perry "] edition = "2018" -license = "MIT/Apache-2.0" -description = "thin DOM wrapper, suitable for use in-browser or for rendering HTML strings anywhere" -repository = "https://github.com/anp/moxie" [package.metadata.docs.rs] default-target = "wasm32-unknown-unknown" diff --git a/dom/raf/CHANGELOG.md b/dom/raf/CHANGELOG.md new file mode 100644 index 000000000..5525a0fd6 --- /dev/null +++ b/dom/raf/CHANGELOG.md @@ -0,0 +1 @@ +# raf releases \ No newline at end of file diff --git a/dom/raf/Cargo.toml b/dom/raf/Cargo.toml index 4191bc1d7..69ebed0c1 100644 --- a/dom/raf/Cargo.toml +++ b/dom/raf/Cargo.toml @@ -1,11 +1,17 @@ [package] name = "raf" version = "0.2.0-pre" -edition = "2018" -authors = ["Adam Perry "] -license = "MIT/Apache-2.0" description = "browser event loop scheduler using requestAnimationFrame" -repository = "https://github.com/anp/moxie" +categories = ["asynchronous", "concurrency", "gui", "wasm", "web-programming"] +keywords = ["scheduler", "events", "requestAnimationFrame"] +readme = "CHANGELOG.md" + +# update here, update everywhere! +license = "MIT/Apache-2.0" +homepage = "https://moxie.rs" +repository = "https://github.com/anp/moxie.git" +authors = ["Adam Perry "] +edition = "2018" [dependencies] futures = "0.3" diff --git a/illicit/CHANGELOG.md b/illicit/CHANGELOG.md new file mode 100644 index 000000000..a8327acb8 --- /dev/null +++ b/illicit/CHANGELOG.md @@ -0,0 +1,3 @@ +# illicit releases + +TODO \ No newline at end of file diff --git a/illicit/Cargo.toml b/illicit/Cargo.toml index d2b35fc9b..bdd707c29 100644 --- a/illicit/Cargo.toml +++ b/illicit/Cargo.toml @@ -1,11 +1,17 @@ [package] name = "illicit" version = "0.10.0-pre" -edition = "2018" -authors = ["Adam Perry "] +description = "Type-indexed, dynamically-scoped, thread-local singletons." +categories = ["development-tools::testing", "gui", "rust-patterns"] +keywords = ["context", "global", "singleton"] +readme = "CHANGELOG.md" + +# update here, update everywhere! license = "MIT/Apache-2.0" -description = "Type-indexed dynamically-scoped singletons." -repository = "https://github.com/anp/moxie" +homepage = "https://moxie.rs" +repository = "https://github.com/anp/moxie.git" +authors = ["Adam Perry "] +edition = "2018" [dependencies] illicit-macro = { path = "macro", version = "0.10.0-pre"} diff --git a/illicit/macro/Cargo.toml b/illicit/macro/Cargo.toml index 8b6ec3c30..1245a4615 100644 --- a/illicit/macro/Cargo.toml +++ b/illicit/macro/Cargo.toml @@ -1,13 +1,15 @@ [package] name = "illicit-macro" version = "0.10.0-pre" -authors = ["Adam Perry "] -edition = "2018" -license = "MIT/Apache-2.0" description = "procedural macros for the illicit crate" -repository = "https://github.com/anp/moxie" +readme = "../CHANGELOG.md" -include = ["Cargo.toml", "src/**/*.rs"] +# update here, update everywhere! +license = "MIT/Apache-2.0" +homepage = "https://moxie.rs" +repository = "https://github.com/anp/moxie.git" +authors = ["Adam Perry "] +edition = "2018" [lib] proc-macro = true diff --git a/mox/CHANGELOG.md b/mox/CHANGELOG.md new file mode 100644 index 000000000..374501b46 --- /dev/null +++ b/mox/CHANGELOG.md @@ -0,0 +1,3 @@ +# mox releases + +TODO \ No newline at end of file diff --git a/mox/Cargo.toml b/mox/Cargo.toml index 7da51a303..44e1096f0 100644 --- a/mox/Cargo.toml +++ b/mox/Cargo.toml @@ -1,11 +1,17 @@ [package] name = "mox" version = "0.3.0-pre" -edition = "2018" -authors = ["Adam Perry "] +description = "Mockery Of X(ML): a JSX-alike syntax for the builder pattern." +categories = ["gui", "rust-patterns"] +keywords = ["jsx", "xml", "builder"] +readme = "CHANGELOG.md" + +# update here, update everywhere! license = "MIT/Apache-2.0" -description = "Mockery Of X(ML): a JSX-like macro for moxie." -repository = "https://github.com/anp/moxie" +homepage = "https://moxie.rs" +repository = "https://github.com/anp/moxie.git" +authors = ["Adam Perry "] +edition = "2018" [lib] proc-macro = true diff --git a/topo/CHANGELOG.md b/topo/CHANGELOG.md new file mode 100644 index 000000000..339c2f8dd --- /dev/null +++ b/topo/CHANGELOG.md @@ -0,0 +1,3 @@ +# topo releases + +TODO \ No newline at end of file diff --git a/topo/Cargo.toml b/topo/Cargo.toml index 9c563233d..832f0f8bc 100644 --- a/topo/Cargo.toml +++ b/topo/Cargo.toml @@ -1,13 +1,17 @@ [package] name = "topo" version = "0.10.0-pre" +description = "Caching and runtime identifiers for dynamic callgraphs" +categories = ["caching", "data-structures", "gui", "memory-management", "rust-patterns"] +keywords = ["cache", "memoize", "intern", "topology", "incremental"] +readme = "CHANGELOG.md" + +# update here, update everywhere! +license = "MIT/Apache-2.0" +homepage = "https://moxie.rs" +repository = "https://github.com/anp/moxie.git" authors = ["Adam Perry "] edition = "2018" -license = "MIT/Apache-2.0" -description = "Stable runtime identifiers for repetitive dynamic callgraphs" -repository = "https://github.com/anp/moxie" - -include = ["Cargo.toml", "src/**/*.rs", "benches/**/*.rs", "tests/**/*.rs"] [dependencies] illicit = { path = "../illicit", version = "0.10.0-pre"} diff --git a/topo/macro/Cargo.toml b/topo/macro/Cargo.toml index 5d3c52e89..2187ac8d7 100644 --- a/topo/macro/Cargo.toml +++ b/topo/macro/Cargo.toml @@ -1,13 +1,15 @@ [package] name = "topo-macro" version = "0.10.0-pre" -authors = ["Adam Perry "] -edition = "2018" -license = "MIT/Apache-2.0" description = "procedural macros for the topo crate" -repository = "https://github.com/anp/moxie" +readme = "../CHANGELOG.md" -include = ["Cargo.toml", "src/**/*.rs"] +# update here, update everywhere! +license = "MIT/Apache-2.0" +homepage = "https://moxie.rs" +repository = "https://github.com/anp/moxie.git" +authors = ["Adam Perry "] +edition = "2018" [lib] proc-macro = true