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

Improve documentation on usage #487

Open
davesnx opened this issue Feb 29, 2024 · 2 comments
Open

Improve documentation on usage #487

davesnx opened this issue Feb 29, 2024 · 2 comments

Comments

@davesnx
Copy link

davesnx commented Feb 29, 2024

I need to check the steps on this gist in order to publish a package properly.

Could this be part of the repo/documentation?

@gpetiot
Copy link
Member

gpetiot commented Mar 19, 2024

Steps 4, 5 and 6 from this gist are just dune-release, so basically:

  • optional: integrate dune-release lint to your CI
  • dune-release tag x.y.z
  • dune-release

@davesnx
Copy link
Author

davesnx commented Mar 19, 2024

For the happy path, sure dune-release works out of the box, but I haven't had a single run succeeding at it, and I found a few error states:

  • bad github token (+ really bad error message and where to setup it)
  • it didn't consider changelog
  • failed at dirty repo
  • failed when tag is already pushed
  • missing git modules

So, the guide I'm thinking is to handle all of those steps and explain those quirks we have been facing into a guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants