Publish on crates.io - Githubissues

alan-turing-institute / trustchain

Trustworthy decentralised PKI

https://alan-turing-institute.github.io/trustchain/

Apache License 2.0

11 stars 5 forks source link

Publish on crates.io #174

Open thobson88 opened 5 months ago

thobson88 commented 5 months ago

Use GitHub account: trustchain-devs with email trustchain.devs@gmail.com.

(Note: this is a new gmail account, not to be confused with trustchaindevstest@gmail.com used for the demo.)

TODO: decide how to publish the whole workspace, given that it's not supported by default (see here).

There's a crate for workspace publishing which looks promising, but to get the right name for the whole workspace I think we'll need to add name = trustchain to the top-level Cargo.toml.

That means making changes after the v0.1.0 tagged commit, which is annoying.

Alternatively we could just do some merging, update the metadata in Cargo.toml, tag the new release as v0.2.0 and publish that instead.

thobson88 commented 5 months ago

Remaining tasks for crates.io:

Check cargo-release whether to use over cargo-publish
Fix build on 174 (cargo build is broken by the new [package] section in top-level Cargo.toml)
Make PR from 174 and merge 174 with workspace toml changes
Tag release as v0.2.0 and publish draft
Check process for docs.rs publication (is this automatic?)

sgreenbury commented 5 months ago

See documentation guide.

thobson88 commented 5 months ago

TODO:

Doc comments for all modules
Doc comments for all functions in the public API (but not enum variants)

thobson88 commented 5 months ago

UPDATE: We have a major obstacle because all dependencies must themselves be published on crates.io, which is a problem for us because Trustchain depends on our forks of third party repositories (specifically SSI and RSS).

See here and discussion here.

This would mean publishing our forks of those repos before publishing Trustchain, which seems daft.

To get the API docs online (which was part of the motivation for publishing), I'm going to try to build them into the new mkdocs site on GitHub pages #173.

sgreenbury commented 5 months ago

Additional discussion on crates.io and forks.

thobson88 commented 4 months ago

Obstacle overcome! See #179 and PR #180.

Next step is to check doc comments and then publish from the publish branch.

sgreenbury commented 1 month ago

Adding some additional modifications that might be worthwhile to include in this release:

[x] Remove unused deps (e.g. with cargo-machete)
[x] Add workspace deps to simplify deps/versions across the workspace members (e.g. with cargo-autoinherit)
[x] Restructure workspace members into a crates/ path (e.g. ssi and polars). I think it probably makes sense to keep the overall trustchain package (currently re-exports of the workspace member crates) as a package at the workspace level rather than a member.
[ ] Add remaining doc comments: these can be identified adding to the .cargo/config.toml to return warnings:
```
[build]
rustflags = ["-Wmissing-docs"]
```