Closed kbolino closed 11 months ago
About half of my issues seem to be Windows-related. I had fewer problems building on Mac. It's probably a good idea to note in README.md and/or CONTRIBUTING.md that building on Windows is not well supported. In particular, on my Mac:
go-yaml
~ spew.Dump(c._cfgAsMap)
seemed to show an infinitely nested structure, so this is probably not an issue specific to go-yaml
)mkdocs.serve
worked fineI'd still recommend:
alias task='go run github.com/go-task/task/v3/cmd/task'
.mkdocs.install
or mkdocs.serve
I can make these changes in this or another PR if there's interest/agreement.
I think I've isolated the issue that causes infinite recursion but only on Windows, I will file an issue report and a PR
Thanks for the PR. Sorry your contributing experience was so fraught. I think it's definitely an opportunity for me to clarify/simplify some things. The mkdocs-material insiders thing is 100% something we can fix though.
I'll review in the coming days.
Cheers, a lot of my pain seems to have been self-inflicted by using Windows.
All modified lines are covered by tests :white_check_mark:
Comparison is base (
9d79f3a
) 74.91349% compared to head (25befa2
) 75.44910%. Report is 1 commits behind head on master.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Description
Adds
exclude-regex
to the configuration, which has the inverse effect asinclude-regex
. I decided to only honorexclude-regex
ifinclude-regex
was also set, but that decision is not necessarily the correct one; it merely simplifies the logic in the code.Type of change
Version of Golang used when building/testing:
How Has This Been Tested?
There are fairly comprehensive unit test cases added to
TestConfig_ShouldGenerateInterface
inpkg/config/config_test.go
.However I could not compute test coverage because I get a stack overflow panic from an unrelated test, which also occurs on master before my change (details below).
Checklist
Feedback on the Checklist
I ran into several issues when trying to contribute:
As mentioned already, there's a stack overflow panic in a test. This may be a Windows-specific issue, I don't know, but it seems to be in the YAML encoder.
The README/CONTRIBUTING directions weren't really accurate for me. For one thing,
go mod download -x
doesn't seem to do anything. It certainly doesn't installtask
nor put it on my PATH. I ended up using the somewhat cumbersomego run github.com/go-task/task/v3/cmd/task
instead.Nowhere do I see it mentioned that you need Python, nor that you need to set up a Python virtual environment to run
pip install
formkdocs.install
task.Speaking of
mkdocs.install
, it does not work out of the box unless I guess you have special insider access to mkdocs-material-insiders:I had to replace the offending line in
docs/requirements.txt
:with the more forgiving (but perhaps invalid?):
And in the end I still couldn't run
mkdocs.serve
, again probably because I'm on Windows: