Skip to content
This repository has been archived by the owner on May 1, 2022. It is now read-only.

[plasma-store] publish to crates.io #1

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[plasma-store] publish to crates.io #1

wants to merge 1 commit into from

Conversation

irakliyk
Copy link
Contributor

This PR will prepare plasma-store crate for publishing to crates.io. I believe the tasks are:

  • Add rust-style comments to describe the crate
  • Generate documentation
  • Get credentials for publishing

Anything else?

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Feb 11, 2021
@irakliyk irakliyk requested a review from kevinlewi February 11, 2021 22:05
@kevinlewi
Copy link

A nice-to-have but not a requirement: take a look at this publish script which will sync github releases with publishing to crates.io: https://github.com/novifinancial/opaque-ke/blob/master/.github/workflows/publish.yml

Also, in terms of directory structure, any reason why we still need to maintain the plasma-store/ directory instead of just collapsing its contents into the root directory? (i.e. can we get rid of the workspace singleton and just put the src/ folder along side the LICENSE, README.md. etc?)

@irakliyk
Copy link
Contributor Author

Thank you! I'll add the publish script.

As for directory structure, I'm planning to add another crate for plasma-stream here, and maybe more crates in the future if we need to add any functionality which doesn't fit into these two crates.

@facebook-github-bot
Copy link

Hi @irakliyk!

Thank you for your pull request.

We require contributors to sign our Contributor License Agreement, and yours needs attention.

You currently have a record in our system, but the CLA is no longer valid, and will need to be resubmitted.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants