Cleanup repo

[half-shell]

• Replace TravisCI build badge with a working one
• Create issues for existing TODO items in the README.md
• Move / copy usage and reference documentation into the appropriate @moduledoc and @doc
• Replace Mix.Task with a Makefile and elixir_make

[vitalis]

@half-shell joined the cleanup discussion.

1: I'm sure that "Replace TravisCI build badge with a working one" it's a no brainer
2: Create issues for existing TODO items in the README.md... this task should align with current vision for the project and @half-shell you probably can shade a light on this.
3: "Move / copy usage and reference documentation into the appropriate @moduledoc and @doc".. also no brainer..
4: "Replace Mix.Task with a Makefile and elixir_make"... if you can explain why.. it will be amazing...

Will appreciate your fast feedback.
Thank you

[vitalis]

Probably the project is no longer active on Travis CI

[half-shell]

Hi there @vitalis 👋

Yes, the Travis CI has been discontinued. We are on the path to using Github actions instead.

To answer your previous post:

1. It is instead a no-brainer. We already have a template for our GitHub actions. You can find a similar recent PR adding it on our ewebmachine repo. It also contains what we'd want in our README title as far as shields go. With the caveat that it might need a few changes that I'll describe in the fourth bullet point.
2. Absolutely. In its current state, it is also quite an easy thing to do. As a first step, and since those TODO items are not prioritized, a simple issue per line in the TODO list should do the trick. I will create them ASAP so if you're keen on tackling on this you should just be able to remove them from the README.md file.
3. You got that one right 👍
4. This change is mostly done already. I've done most of the work already, I just haven't gone around to open a PR. You can find the diff here. The only thing left is to make it work with a win32 Github runner.

As a first step, I can open a PR with the elixir_make build refactoring, and you can work off of that branch to make the changes mentioned above. I might be able to come back to it during the next couple of weeks to fix that win32 runner issue.

Would that work for you ?

[vitalis]

@half-shell Sounds like a plan, let's start with the PR.. As I see it also has the GitHub actions implementation, so you kill two birds in one strike...

[vitalis]

I can do a code review, and I have a proposal for smaller PRs in the future :)

[vitalis]

@half-shell beside the current topic / issue there are 3 open issues from a far past, can you please review the issue and close the irrelevant / assign the relevant to me?
Thank you

[vitalis]

@half-shell maybe I'm wrong but in my project there is much simpler solution for iconv setup:

❯ cat mix.exs | grep "iconv"
      {:eiconv,
       github: "zotonic/eiconv", ref: "afb569803098ee8d9c01f07e8ac58057046ce8ff", manager: :rebar3},
❯ cat rebar.config
{plugins, [
  {pc, "1.14.0"}
]}.

{provider_hooks, [
  {pre, [{compile, {pc, compile}},
         {clean, {pc, clean}}]}
]}.

That's it.. it took me a day or two to find the solution.. I'm using :gen_smtp_server for incoming email.

[half-shell]

I'll open the PR some time today, I'm sorry I didn't manage to do it yesterday. You're more than welcome to provide an alternative to the way iconv is built !

However, keep in mind that the changes made in this context are meant to be as small as possible. So the idea here is still to keep our own iconv_nif.c, and not add any new dependencies.

We are not hostile to any changes in that direction, but it doesn't fit this cleanup pass' intention.

We're more than open to discuss this matter through a new issue down the line.

I'll try to sort out the opened issues this week, but I can't make any promises.

On a side note, please stop tagging me on every comment you post on this thread; I'm already notified since I created the issue.

[vitalis]

@half-shell Let's continue with your PR, I don't want to introduce new changes till the existing tasks are complete :)
And I completely agree with you on adding new dependencies.