diff options
| author | Jakub Jirutka <jakub@jirutka.cz> | 2018-01-18 14:16:31 +0100 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2018-11-02 12:20:50 +0100 |
| commit | cb3f8510980bf02a1187c40d87df130e517f868d (patch) | |
| tree | 48f4d066c76160f6db503686cfabc8c0038a55c9 | |
| parent | c0d30fad978de58da6d78d8fddcfccf602ebfe82 (diff) | |
| download | gitlab-ce-cb3f8510980bf02a1187c40d87df130e517f868d.tar.gz | |
Render index.* like README.* when it's present in a directory
Resolves #18933
| -rw-r--r-- | changelogs/unreleased/18933-render-index-as-readme.yml | 5 | ||||
| -rw-r--r-- | lib/gitlab/file_detector.rb | 2 | ||||
| -rw-r--r-- | spec/lib/gitlab/file_detector_spec.rb | 6 |
3 files changed, 11 insertions, 2 deletions
diff --git a/changelogs/unreleased/18933-render-index-as-readme.yml b/changelogs/unreleased/18933-render-index-as-readme.yml new file mode 100644 index 00000000000..49a6a7929b2 --- /dev/null +++ b/changelogs/unreleased/18933-render-index-as-readme.yml @@ -0,0 +1,5 @@ +--- +title: Make index.* render like README.* when it's present in a repository +merge_request: 16550 +author: Jakub Jirutka +type: added diff --git a/lib/gitlab/file_detector.rb b/lib/gitlab/file_detector.rb index 4d89ee5a669..898dc7b0e23 100644 --- a/lib/gitlab/file_detector.rb +++ b/lib/gitlab/file_detector.rb @@ -8,7 +8,7 @@ module Gitlab module FileDetector PATTERNS = { # Project files - readme: %r{\Areadme[^/]*\z}i, + readme: %r{\A(readme|index)[^\/]*\z}i, changelog: %r{\A(changelog|history|changes|news)[^/]*\z}i, license: %r{\A((un)?licen[sc]e|copying)(\.[^/]+)?\z}i, contributing: %r{\Acontributing[^/]*\z}i, diff --git a/spec/lib/gitlab/file_detector_spec.rb b/spec/lib/gitlab/file_detector_spec.rb index 294ec2c2fd6..f0e7bd28ec0 100644 --- a/spec/lib/gitlab/file_detector_spec.rb +++ b/spec/lib/gitlab/file_detector_spec.rb @@ -15,7 +15,11 @@ describe Gitlab::FileDetector do describe '.type_of' do it 'returns the type of a README file' do - expect(described_class.type_of('README.md')).to eq(:readme) + %w(README readme INDEX index).each do |filename| + %w(.md .adoc).each do |extname| + expect(described_class.type_of(filename + extname)).to eq(:readme) + end + end end it 'returns nil for a README file in a directory' do |