Public api

[jwiesler]

Observations:

• I omitted auto derived impls and blanket impls, which brought down the api json file from 25mb to 7mb
• cargo public-api diff does not work, I couldn't get features to be passed to diff (opened an issue for this)
• The test workflow would work, however, the output is not diffed and the file is 7mb. So this file would have to be diffed manually and the pipeline would always just report "not the same". Maybe there is some nice diff tool that can be used to generate a diff in the pipeline.

Open questions:

• Does public-api exposes some api to generate the diff programatically?
• Which features do we want to use to check this?
  • With diff we could check the whole matrix
  • With the test approach every combination of features will need a dedicated file which adds up quickly in repo size

Update: cargo public-api diff should work after they release a new version on crates.io. This is also what I would use. However, how would we use this? As an optional check just to at least see that something changed?

[arlyon]

Hi! It would be handy if we could get a comment on each PR with the changes. It would really help during the weekly codegen changes to see what is different (and by extension the changelogs :))

[jwiesler]

This is a proof of concept for cargo public api, we need to talk about what to integrate (I'd favor the job instead of the test). It'd also be great if the new client features would be additive insteadof exclusive such that we can use one tests run, one clippy run and one public-api job run instead of n.

[arlyon]

Will take a proper look at this tonight and come back with some detailed comments. Thanks!

[arlyon]

Nice, I can see the PR is closed out so I will see if I can get this working. I have a CI step that produces unpublished APIs, we can reuse that to post a comment on PRs

[github-actions[bot]]

Removed items from the public API

(none)

Changed items in the public API

(none)

Added items to the public API

(none)

[arlyon]

^ nice! shall we get rid of the test and just use this @jwiesler?

[jwiesler]

Sure! I'll just do it right now.

[jwiesler]

@arlyon as far as I remember this has one problem: The ci token of actions that run from a commiter that is not a collaborator has severly reduced permissions and can't generate/edit comments.

Edit: see https://stackoverflow.com/a/71683208

[jwiesler]

I fixed it. Can't merge it though since tokio-hyper doesn't compile on the current nightly (seems to me)

[arlyon]

:tada: This PR is included in version 0.40.0 :tada:

The release is available on:

• v0.40.0
• GitHub release

Your semantic-release bot :package::rocket: