Move the release process docs into the repo#13681
Merged
shonfeder merged 1 commit intoocaml:mainfrom Feb 26, 2026
Merged
Conversation
Currently the release process documentation is located at https://github.com/ocaml/dune/wiki/Release-process But the release process is a critical part of the SDLC of any OSS project, and documentation of the process should ideally leave alongside the code itself. In particular, this enables - an easier route to gradually evolving the [documentation into automation](https://cacm.acm.org/practice/documentation-is-automation/) - an easy way for us to coordinate on the evolution of the process itself (i.e., via PRs) over the docs. Signed-off-by: Shon Feder <shon.feder@gmail.com>
Alizter
approved these changes
Feb 26, 2026
Collaborator
Alizter
left a comment
Alizter
left a comment
There was a problem hiding this comment.
Seems reasonable. Any reason we need a release subdirectory in doc/dev?
Member
Author
|
There are likely to be more release related assets, scripts, or images, etc. Thanks for the review! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently the release process documentation is located at https://github.com/ocaml/dune/wiki/Release-process
But the release process is a critical part of the SDLC of any OSS project, and documentation of the process should ideally leave alongside the code itself. In particular, this enables
NOTE for review: This PR adds the current doc from the wiki verbatim (with the exception of the added comment recording this provenance). Please do not review the content at this time, but just approve or otherwise based on whether you agree this should be moved into our dev docs.
As per point (2), this will be followed with substantive updates and revisions to the documentation. The diff will allow us to evaluate the details of the improvements and corrections I will propose.