Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PQ code package update script #323

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

jschneider-bensch
Copy link
Collaborator

@jschneider-bensch jschneider-bensch commented Jun 18, 2024

This is part of the planned workflow for packaging libcrux-ml-kem in the PQ code package. (cf. #302)

The script copies files from an allow-list over to the PQCP repo submodule directory. It then runs tests using the default features and upon success creates a signed-off commit in the submodule on a separate branch named after the libcrux revision. Pushing needs to be done manually.
The allow-list does not include e.g. everything related to C code extraction.

@jschneider-bensch jschneider-bensch mentioned this pull request Jun 18, 2024
6 tasks
@jschneider-bensch
Copy link
Collaborator Author

Waiting on #327 and #329 for further changes before marking this ready for review.

@jschneider-bensch
Copy link
Collaborator Author

I've updated the custom Cargo.toml to include the feature flags from #327, #333 and those that will probably land with #329.

@jschneider-bensch jschneider-bensch marked this pull request as ready for review June 27, 2024 13:34
Copy link
Member

@franziskuskiefer franziskuskiefer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, generally looks good with some comments and questions.

I'm also wondering if we should tie the two a little closer togther. We could make libcrux a git submodule for the pqcp repo and then pull it in on that side? Just an idea, trying to see how we can make this as seamless and hassle-free as possible.

libcrux-ml-kem/pqcp/Cargo.toml Outdated Show resolved Hide resolved
libcrux-ml-kem/pqcp/Cargo.toml Outdated Show resolved Hide resolved
libcrux-ml-kem/update-pqcp.sh Outdated Show resolved Hide resolved
@franziskuskiefer franziskuskiefer changed the base branch from dev to main July 4, 2024 11:46
cp -r "$item" "$pqcp_repo"
done < "$allowlist"

python "$libcrux_ml_kem_crate/pqcp/cargo.py" "$libcrux_root"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

python doesn't exist on many systems. You probably want python3.

cargo clean

message="$(printf "mlkem-rust-libcrux PQ code packages update\n\n$(date): libcrux revision $(git -C $libcrux_root rev-parse HEAD)")"
git switch -c "libcrux-ml-kem-$(git -C $libcrux_root rev-parse HEAD)"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This moved the libcrux repo over to this revision. Something doesn't seem quite right here.

Copy link

This PR has been marked as stale due to a lack of activity for 60 days. If you believe this pull request is still relevant, please provide an update or comment to keep it open. Otherwise, it will be closed in 7 days.

@github-actions github-actions bot added the stale label Sep 11, 2024
@franziskuskiefer
Copy link
Member

We finally need to get back to this. This may be a little stale. But still the thing to do.

@github-actions github-actions bot removed the stale label Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏗 In progress
Development

Successfully merging this pull request may close these issues.

2 participants