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.

Sign up for GitHub

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

Jump to bottom

Render READMEs in docs/ .gitea or .github from root #10361

Merged
merged 9 commits into from
Feb 21, 2020
Merged

Render READMEs in docs/ .gitea or .github from root #10361

merged 9 commits into from
Feb 21, 2020

Conversation

zeripath
Copy link
Contributor

Fixes: #5370

@zeripath zeripath added the type/feature Completely new functionality. Can only be merged if feature freeze is not active. label Feb 19, 2020
@zeripath zeripath added this to the 1.12.0 milestone Feb 19, 2020
@codecov-io
Copy link

codecov-io commented Feb 19, 2020 •
edited
Loading

Codecov Report

Merging #10361 into master will increase coverage by 0.04%.
The diff coverage is 41.33%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #10361      +/-   ##
==========================================
+ Coverage   43.67%   43.71%   +0.04%     
==========================================
  Files         585      586       +1     
  Lines       81080    81223     +143     
==========================================
+ Hits        35414    35510      +96     
- Misses      41279    41321      +42     
- Partials     4387     4392       +5
Impacted Files Coverage Δ
models/repo.go 51.32% <0%> (-0.04%) ⬇️
routers/repo/view.go 37.17% <41.89%> (+0.81%) ⬆️
services/pull/temp_repo.go 29.05% <0%> (-2.57%) ⬇️
services/pull/patch.go 60.37% <0%> (-2.52%) ⬇️
routers/home.go 46.8% <0%> (-0.81%) ⬇️
models/issue.go 53.82% <0%> (-0.13%) ⬇️
modules/indexer/code/bleve.go 64.7% <0%> (-0.06%) ⬇️
modules/indexer/code/indexer.go 42.62% <0%> (ø) ⬆️
modules/analyze/code_langauge.go 81.25% <0%> (ø)
modules/setting/indexer.go 91.89% <0%> (+0.22%) ⬆️
... and 12 more

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 c13c0b9...6d78baf. Read the comment docs.

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Feb 19, 2020
@lunny
Copy link
Member

lunny commented Feb 19, 2020

@zeripath Could you add a test for this?

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Feb 19, 2020
@zeripath
Copy link
Contributor Author

@lunny I'd love to if you could tell me an example test to look at...

zeripath
zeripath commented Feb 19, 2020
View reviewed changes
@lafriks
Copy link
Member

lafriks commented Feb 19, 2020

Check out this for better file/dir reading using src-d: https://github.com/src-d/go-license-detector/blob/63bc9348890a362ea9cc95e78b68c67db2aba656/licensedb/filer/filer.go#L111

guillep2k
guillep2k reviewed Feb 20, 2020
View reviewed changes
@zeripath
Copy link
Contributor Author

So @lafriks I don't think we can do that if we want to continue to allow Readme/README/ReAdMe/etc. we can't just query each individual type so we have to walk the directory structure.

guillep2k
guillep2k reviewed Feb 21, 2020
View reviewed changes
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Feb 21, 2020
@jolheiser jolheiser merged commit c8d1c38 into go-gitea:master Feb 21, 2020
@zeripath zeripath deleted the default-readmes branch February 22, 2020 03:07
@m-a-v
Copy link

m-a-v commented Jun 10, 2020

Symbolic links are also supported?

README.md -> my/own/subdirectory/README.md

@zeripath
Copy link
Contributor Author

yes

@m-a-v
Copy link

m-a-v commented Jun 10, 2020

Awesome. Thanks!

@go-gitea go-gitea locked and limited conversation to collaborators Nov 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mrsdizzie mrsdizzie mrsdizzie approved these changes

@sapk sapk sapk left review comments

@kolaente kolaente kolaente left review comments

@lafriks lafriks lafriks approved these changes

@guillep2k guillep2k guillep2k approved these changes

Assignees
No one assigned
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. type/feature Completely new functionality. Can only be merged if feature freeze is not active.
Projects
None yet
Milestone
1.12.0
Development

Successfully merging this pull request may close these issues.

Display README.md from docs/, .github/, or other (.gitea/ ?)