Update docs issue #1

[nelsonic]

@SimonLab please have a look when you can. thanks.

[codecov]

Codecov Report

Merging #11 (2298a13) into main (25c6e48) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main       #11   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            5         5           
  Lines          129       126    -3     
=========================================
- Hits           129       126    -3     

Impacted Files	Coverage Δ
lib/helpers.ex	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 25c6e48...2298a13. Read the comment docs.

[nelsonic]

I don't understand why the "test msg" is being committed to the actual repo ...

Noticed it yesterday: https://github.com/dwyl/gitea/commits/main

But didn't think anything of it ... thought you were just testing something. 🤷‍♂️

[SimonLab]

re #11 (comment)
I think the commits are created when the tests are failing, maybe some cleaning up function haven't had the time to run

[SimonLab]

I've added a few comments, let me know what you think 👍

[nelsonic]

If I run the tests with mock: false

I get the following:

Finished in 12.1 seconds (12.1s async, 0.00s sync)
3 doctests, 29 tests, 5 failures

Randomized with seed 276120
----------------
COV    FILE                                        LINES RELEVANT   MISSED
100.0% lib/git_mock.ex                                55        7        0
 72.9% lib/gitea.ex                                  244       48       13
100.0% lib/helpers.ex                                133       14        0
100.0% lib/http.ex                                   135       24        0
 96.2% lib/httpoison_mock.ex                         164       26        1
[TOTAL]  88.2%
----------------
Generating report...
Saved to: cover/
FAILED: Expected minimum coverage of 100%, got 88.2%.

[nelsonic]

I added a test in #13 which is now on main which means mix c with mock: false we get:

Finished in 21.1 seconds (21.1s async, 0.00s sync)
6 doctests, 30 tests, 0 failures

Randomized with seed 456290
----------------
COV    FILE                                        LINES RELEVANT   MISSED
100.0% lib/git_mock.ex                                55        7        0
100.0% lib/gitea.ex                                  244       48        0
100.0% lib/helpers.ex                                153       16        0
100.0% lib/http.ex                                   135       24        0
100.0% lib/httpoison_mock.ex                         164       26        0
[TOTAL] 100.0%
----------------
Generating report...
Saved to: cover/

✅

[nelsonic]

Getting this annoying error in the gitea-demo app:

[error] ERROR: GITEA_SSH_PORT Environment Variable is not set

until this PR is merged ... ⏳

Fixing the failing test. 🧑‍💻

[nelsonic]

Tests fixed.

Test commits still being added to the parent repo.

@SimonLab please review when you're back from lunch. 🙏

[nelsonic]

The IO.inspects are in the tests. they are noisy for now but aren't exported to the actual module. We can remove them later.

[SimonLab]

Running tests work (mock true and false) on a fresh clone of Gitea.
The only question I have is linked to the Gitea.commit function using git add . -f
I've run the tests without the flag -f and it seems to work.

[nelsonic]

@SimonLab review comments addressed. -f removed. New version in mix.exs and README.md.
Will publish to Hex.pm once you have reviewed/merged. Thanks. 👍

[SimonLab]

Thanks for cleaning the port related code

[nelsonic]

Package published to https://hex.pm/packages/gitea/1.0.3 📦 🚀