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.

Sign up for GitHub

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

Jump to bottom

doc: release procedure #971

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

doc: release procedure #971

wants to merge 3 commits into from

Conversation

W95Psp
Copy link
Collaborator

@W95Psp W95Psp commented Oct 7, 2024

This PR adds some documentation regarding the procedure for publishing hax.
It also tweaks some settings for cargo release:

  • adds a hook for asking dune to regenerate opam files
  • add settings to ignore certain (internal) crates

@W95Psp W95Psp mentioned this pull request Oct 7, 2024
Open
9 tasks
franziskuskiefer
franziskuskiefer approved these changes Oct 8, 2024
View reviewed changes
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.

Instructions for ocaml seem to be missing. Otherwise lgtm

cli/subcommands/Cargo.toml Show resolved Hide resolved
engine/names/Cargo.toml Outdated Show resolved Hide resolved
engine/names/extract/Cargo.toml Outdated Show resolved Hide resolved
hax-lib-protocol-macros/Cargo.toml Outdated Show resolved Hide resolved
hax-lib-protocol/Cargo.toml Outdated Show resolved Hide resolved
test-harness/Cargo.toml Outdated Show resolved Hide resolved
PUBLISHING.md

## OCaml

There is only the package `hax-engine`, that includes a binary and a
Copy link
Member

Choose a reason for hiding this comment

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

How does publishing work here? Also, did you want to publish this to opam? I don't see it there.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I pushed a note, where I explain what we discussed (pinning git basically)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If the note looks good to you, let's resolve this discussion and merge the PR

Copy link
Member

Choose a reason for hiding this comment

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

lgtm
Please add a note how to update the README if needed, or how the release tag get's on there. Since we don't push it anywhere else, that's essentially the release then and we should describe here how to do that.
Then you can resolve this and merge.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

makes sense, started something in branch document-stable-install

@W95Psp @franziskuskiefer
fix: missing newlines
4f95210 
Co-authored-by: Franziskus Kiefer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@franziskuskiefer franziskuskiefer franziskuskiefer approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@W95Psp @franziskuskiefer