search

200ok-ch / org-parser

org-parser is a parser for the Org mode markup language for Emacs.
GNU Affero General Public License v3.0
326 stars 16 forks source link

Add deps.edn #22

Closed rollacaster closed 3 years ago

rollacaster commented 3 years ago

Following the discussion in #19 this facilitates using org-parser with a deps.edn project.

This is only a temporary solution since it's not possible to include org-parser via leiningen/boot. For a proper solution the library could be pushed to Clojars. I created an example how this could work:

https://github.com/rollacaster/org-parser/blob/deploy-to-clojars/.github/workflows/deploy-clojars.yml

I didn't open a pull request for this, since I used GH Action and you currently use CircleCI (which I've never used, but perhaps the GH Actions example is a useful starting point anyway)

munen commented 3 years ago

Hi @rollacaster

Thank you for your PR! Motivated by your good work, we started working on what you called the 'proper solution'. On merging a branch to master, CI automatically bumps to the next patch version and releases to Clojars. It did take a couple of tries to get it right, hence there are multiple releases on Clojars now which actually run the same code. Since it doesn't seem possible to remove an existing release on Clojar, we're going to ignore this.

The library can be found here: https://clojars.org/org-parser/

The latest version is indicated by a banner in the Readme.

If I understand you correctly, then it would be your preference not to have the deps.edn file from your PR in the org-parser codebase, because it can be required as a dependency from Clojars, now. If that's alright, you could adapt the PR and change the docs on how to do that, then I'll happily pull in your changes.

If you're interested on how the automation finally is implemented, here's the PR we've created for it: https://github.com/200ok-ch/org-parser/pull/24

Thank you also very much for the link to your GH actions script - it was a good starting point to actually deploy to Clojars. NB: Using lein release is a rabbit hole and it seems actually easier to call the different tasks manually.

:pray:

rollacaster commented 3 years ago

Hi,

Setting up CI can be a real pain sometimes 😀 but it's great that it worked out in the end.

I updated the README and tested the dependency in org-parser-tree.

munen commented 3 years ago

Sweet, thank you very much for the extra effort and welcome to being an org-parser contributor :pray: :bow: