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

Replacing delegates #188

Open
NathanReb opened this issue Nov 22, 2019 · 0 comments
Open

Replacing delegates #188

NathanReb opened this issue Nov 22, 2019 · 0 comments
Milestone

Comments

@NathanReb
Copy link
Collaborator

@NathanReb NathanReb commented Nov 22, 2019

The idea is to offer non github-based workflows an alternative way to cooperate with dune-release that requires minimal maintenance on our side and to simplify the most common case, publishing to github, in the process.

The issue

Currently delegates can be used to:

  • publish documentation
  • publish tarballs
  • publish arbitrary things or "alt-" targets

The way it works is that dune-release tries to infer whether it should publish to github (the default and so far most common workflow) or publish using a delegate by parsing URLs in the opam file.
These parts of the code are fragile, hard to maintain and lead to bad error reporting at the moment.

Our proposal

The idea here would be to remove the delegate API and the corresponding code in dune-release so that it natively only supports github publication and to offer other users a way to plug their scripts into the dune-release workflow by ensuring intermediate dune-release commands produce the right artifacts to pass on to those scripts rather than invoking them ourselves.

Currently delegates are only passed the path to the distribution tarball, the path to the generated documentation directory and the "publication message". The first two are already written to the file system to a sub directory of _build in a fairly consistent manner. The publication message isn't but it would make sense for dune-release to do so as it is reused across different commands and re-computed by parsing the changelog everytime it's required.

What I suggest here is to add a simple delegate-info command that prints to the standard output the paths and values currently passed to delegate commands. That way external publication tools can use that to get the information they need and use to get from the command line when invoked by dune-release. This allows us to easily maintain a minimal interface with alternative publication workflows while allowing us to change the internal behaviour of tools.

A last point worth mentioning is that to open PRs to opam-repository, dune-release needs to know where the tarball can be downloaded from. This can be set using the --distrib-uri option of dune-release opam. Although this option priority is currently broken, once it is fixed it should provide a way for delegates to give dune-release the information it needs to take on with the rest of the release process.

In short, the new proposed alternative is to let external release scripts invoke dune-release rather than the other way around which seems like a better approach. This plan not only is better for dune-release maintenance but will also make it easier to extend the delegate-info API if external tools need more information from dune-release so I believe it's better for everyone involved.

I suggest the following course of action:

  1. Submit this plan to the community to give affected users an opportunity to speak up and make some adjustments if needed
  2. Add the delegate-info command and release it in a minor release
  3. Deprecate all other delegate related features in a subsequent minor release
  4. Completely drop the old delegate API in the next major release
@NathanReb NathanReb added this to the 1.4.0 milestone Nov 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.