-
Notifications
You must be signed in to change notification settings - Fork 691
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cabal-install: check: Whitelist doc file extensions (#8747)
* check: Test only doc files with supported extensions * Cleanup --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit bae536f)
- Loading branch information
1 parent
05b0630
commit cc75891
Showing
10 changed files
with
10 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 0 additions & 2 deletions
2
...ckageTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/NotExisting/cabal.test.hs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,5 @@ | ||
import Test.Cabal.Prelude | ||
|
||
import System.Directory (createDirectoryIfMissing) | ||
|
||
-- Omitting ChangeLog.md but not README in extra-doc-files | ||
main = cabalTest $ do | ||
cabal "check" [] |
2 changes: 2 additions & 0 deletions
2
.../PackageTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/NotIncluded/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Needed for test, to ensure we test the file extension as well. | ||
!ChangeLog.md~ |
File renamed without changes.
2 changes: 0 additions & 2 deletions
2
...ests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/NotIncluded/V1.12/cabal.test.hs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,5 @@ | ||
import Test.Cabal.Prelude | ||
|
||
import System.Directory (createDirectoryIfMissing) | ||
|
||
-- Omitting ChangeLog.md but not README in extra-doc-files | ||
main = cabalTest $ do | ||
cabal "check" [] |
Empty file.
2 changes: 1 addition & 1 deletion
2
...kageTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/NotIncluded/V3.0/cabal.out
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# cabal check | ||
Warning: These warnings may cause trouble when distributing the package: | ||
Warning: Please consider including the file './ChangeLog.md' in the 'extra-doc-files' section of the .cabal file if it contains useful information for users of the package. | ||
Warning: Please consider including the file './CHANGELOG.TXT' in the 'extra-doc-files' section of the .cabal file if it contains useful information for users of the package. |
2 changes: 0 additions & 2 deletions
2
...Tests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/NotIncluded/V3.0/cabal.test.hs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,5 @@ | ||
import Test.Cabal.Prelude | ||
|
||
import System.Directory (createDirectoryIfMissing) | ||
|
||
-- Omitting ChangeLog.md but not README in extra-doc-files | ||
main = cabalTest $ do | ||
cabal "check" [] |
2 changes: 0 additions & 2 deletions
2
...Tests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/WrongField/V1.12/cabal.test.hs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,5 @@ | ||
import Test.Cabal.Prelude | ||
|
||
import System.Directory (createDirectoryIfMissing) | ||
|
||
-- Included ChangeLog.md but not in extra-doc-files | ||
main = cabalTest $ do | ||
cabal "check" [] |
2 changes: 0 additions & 2 deletions
2
...eTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/WrongField/V3.0/cabal.test.hs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,5 @@ | ||
import Test.Cabal.Prelude | ||
|
||
import System.Directory (createDirectoryIfMissing) | ||
|
||
-- Included ChangeLog.md but not in extra-doc-files | ||
main = cabalTest $ do | ||
cabal "check" [] |