Skip to content

Commit e272806

Browse files
milbrandtbaronfel
authored andcommitted
Update several links (#7055)
* https instead of http for http://github.com, http://fsharp.org, https://fsharp.github.io, https://contributor-covenant.org * update link to git fo windows, https instead of http, mdlint warnings * link updated * replace http://api.github.com/ by https * update some links to https, mdlint warnings * update link * PR feedback
1 parent b46bdc8 commit e272806

File tree

32 files changed

+369
-362
lines changed

32 files changed

+369
-362
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,18 +61,34 @@ Stable builds are available in the NuGet Gallery:
6161

6262
All AppVeyor builds are available using the NuGet feed: https://ci.appveyor.com/nuget/fsgit-fsharp-compiler-service
6363

64-
If using Paket, add the source at the top of `paket.dependencies`.
64+
* [The F# Compiler Technical Guide](https://fsharp.github.io/2015/09/29/fsharp-compiler-guide.html)
65+
* [The F# Language Specification](https://fsharp.org/specs/language-spec/)
6566

6667
## License
6768

68-
This project is subject to the MIT License. A copy of this license can be found in [License.txt](License.txt) at the root of this repo.
69+
This project is subject to the MIT License. A copy of this license is in [License.txt](License.txt).
6970

70-
## Maintainers
71+
## Code of Conduct
72+
73+
This project has adopted the [Contributor Covenant](https://contributor-covenant.org/) code of conduct to clarify expected behavior in our community. You can read it at [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md).
74+
75+
## Get In Touch
76+
77+
Members of the [F# Software Foundation](https://fsharp.org) are invited to the [FSSF Slack](https://fsharp.org/guides/slack/). You can find support from other contributors in the `#compiler` and `#editor-support` channels.
78+
79+
Additionally, you can use the `#fsharp` tag on Twitter if you have general F# questions, including about this repository. Chances are you'll get multiple responses.
7180

7281
The maintainers of this repository are:
7382

7483
- [Don Syme](http://github.com/dsyme)
7584
- [Tomas Petricek](http://github.com/tpetricek)
7685
- [Enrico Sada](http://github.com/enricosada)
7786
- [Chet Husk](http://github.com/baronfel)
78-
- Many people have helped including [Robin Neatherway](https://github.com/rneatherway), [Dave Thomas](http://github.com/7sharp9), [Lincoln Atkinson](http://github.com/latkin), [Kevin Ransom](http://github.com/KevinRansom), [Vladimir Matveev](http://github.com/vladima) and others
87+
- Many people have helped including [Robin Neatherway](https://github.com/rneatherway), [Dave Thomas](http://github.com/7sharp9), [Lincoln Atkinson](http://github.com/latkin), [Kevin Ransom](http://github.com/KevinRansom), [Vladimir Matveev](http://github.com/vladima) and others
88+
89+
## About F\#
90+
91+
* [What is F#](https://docs.microsoft.com/dotnet/fsharp/what-is-fsharp)
92+
* [Get started with F#](https://docs.microsoft.com/dotnet/fsharp/get-started/)
93+
* [F# Software Foundation](https://fsharp.org)
94+
* [F# Testimonials](https://fsharp.org/testimonials)

eng/common/post-build/sourcelink-validation.ps1

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ Set-StrictMode -Version 2.0
1111

1212
. $PSScriptRoot\..\tools.ps1
1313

14-
# Cache/HashMap (File -> Exist flag) used to consult whether a file exist
14+
# Cache/HashMap (File -> Exist flag) used to consult whether a file exist
1515
# in the repository at a specific commit point. This is populated by inserting
1616
# all files present in the repo at a specific commit point.
1717
$global:RepoFiles = @{}
1818

1919
$ValidatePackage = {
20-
param(
20+
param(
2121
[string] $PackagePath # Full path to a Symbols.NuGet package
2222
)
2323

@@ -32,7 +32,7 @@ $ValidatePackage = {
3232
# Extensions for which we'll look for SourceLink information
3333
# For now we'll only care about Portable & Embedded PDBs
3434
$RelevantExtensions = @(".dll", ".exe", ".pdb")
35-
35+
3636
Write-Host -NoNewLine "Validating" ([System.IO.Path]::GetFileName($PackagePath)) "... "
3737

3838
$PackageId = [System.IO.Path]::GetFileNameWithoutExtension($PackagePath)
@@ -46,13 +46,13 @@ $ValidatePackage = {
4646
try {
4747
$zip = [System.IO.Compression.ZipFile]::OpenRead($PackagePath)
4848

49-
$zip.Entries |
49+
$zip.Entries |
5050
Where-Object {$RelevantExtensions -contains [System.IO.Path]::GetExtension($_.Name)} |
5151
ForEach-Object {
5252
$FileName = $_.FullName
5353
$Extension = [System.IO.Path]::GetExtension($_.Name)
5454
$FakeName = -Join((New-Guid), $Extension)
55-
$TargetFile = Join-Path -Path $ExtractPath -ChildPath $FakeName
55+
$TargetFile = Join-Path -Path $ExtractPath -ChildPath $FakeName
5656

5757
# We ignore resource DLLs
5858
if ($FileName.EndsWith(".resources.dll")) {
@@ -62,7 +62,7 @@ $ValidatePackage = {
6262
[System.IO.Compression.ZipFileExtensions]::ExtractToFile($_, $TargetFile, $true)
6363

6464
$ValidateFile = {
65-
param(
65+
param(
6666
[string] $FullPath, # Full path to the module that has to be checked
6767
[string] $RealPath,
6868
[ref] $FailedFiles
@@ -83,15 +83,15 @@ $ValidatePackage = {
8383
ForEach-Object {
8484
$Link = $_
8585
$CommitUrl = "https://raw.githubusercontent.com/${using:GHRepoName}/${using:GHCommit}/"
86-
86+
8787
$FilePath = $Link.Replace($CommitUrl, "")
8888
$Status = 200
8989
$Cache = $using:RepoFiles
9090

9191
if ( !($Cache.ContainsKey($FilePath)) ) {
9292
try {
9393
$Uri = $Link -as [System.URI]
94-
94+
9595
# Only GitHub links are valid
9696
if ($Uri.AbsoluteURI -ne $null -and ($Uri.Host -match "github" -or $Uri.Host -match "githubusercontent")) {
9797
$Status = (Invoke-WebRequest -Uri $Link -UseBasicParsing -Method HEAD -TimeoutSec 5).StatusCode
@@ -128,15 +128,15 @@ $ValidatePackage = {
128128
}
129129
}
130130
}
131-
131+
132132
&$ValidateFile $TargetFile $FileName ([ref]$FailedFiles)
133133
}
134134
}
135135
catch {
136-
136+
137137
}
138138
finally {
139-
$zip.Dispose()
139+
$zip.Dispose()
140140
}
141141

142142
if ($FailedFiles -eq 0) {
@@ -163,13 +163,13 @@ function ValidateSourceLinkLinks {
163163
ExitWithExitCode 1
164164
}
165165

166-
$RepoTreeURL = -Join("http://api.github.com/repos/", $GHRepoName, "/git/trees/", $GHCommit, "?recursive=1")
166+
$RepoTreeURL = -Join("https://api.github.com/repos/", $GHRepoName, "/git/trees/", $GHCommit, "?recursive=1")
167167
$CodeExtensions = @(".cs", ".vb", ".fs", ".fsi", ".fsx", ".fsscript")
168168

169169
try {
170170
# Retrieve the list of files in the repo at that particular commit point and store them in the RepoFiles hash
171171
$Data = Invoke-WebRequest $RepoTreeURL -UseBasicParsing | ConvertFrom-Json | Select-Object -ExpandProperty tree
172-
172+
173173
foreach ($file in $Data) {
174174
$Extension = [System.IO.Path]::GetExtension($file.path)
175175

@@ -183,7 +183,7 @@ function ValidateSourceLinkLinks {
183183
Write-Host $_
184184
ExitWithExitCode 1
185185
}
186-
186+
187187
if (Test-Path $ExtractPath) {
188188
Remove-Item $ExtractPath -Force -Recurse -ErrorAction SilentlyContinue
189189
}

fcs/README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
# The FSharp.Compiler.Service components and NuGet package
42

53
This directory contains the build, packaging, test and documentation-generation logic for the NuGet package ``FSharp.Compiler.Service``. The source for this NuGet
@@ -11,7 +9,7 @@ Basically we are packaging up the compiler as a DLL and publishing it as a NuGet
119

1210
There are subtle differences between FSharp.Compiler.Service and FSharp.Compiler.Private (shipped with the Visual F# Tools)
1311

14-
- FCS has a public API
12+
- FCS has a public API
1513

1614
- FCS is built against **.NET 4.6.1** and **FSharp.Core NuGet 4.6.2** to give broader reach
1715

@@ -67,7 +65,6 @@ You can push the packages if you have permissions, either automatically using ``
6765
..\fsharp\.nuget\nuget.exe push %HOMEDRIVE%%HOMEPATH%\Downloads\FSharp.Compiler.Service.28.0.0.nupkg %APIKEY% -Source https://nuget.org
6866
..\fsharp\.nuget\nuget.exe push %HOMEDRIVE%%HOMEPATH%\Downloads\FSharp.Compiler.Service.MSBuild.v12.28.0.0.nupkg %APIKEY% -Source https://nuget.org
6967
..\fsharp\.nuget\nuget.exe push %HOMEDRIVE%%HOMEPATH%\Downloads\FSharp.Compiler.Service.ProjectCracker.28.0.0.nupkg %APIKEY% -Source https://nuget.org
70-
7168

7269
### Use of Paket and FAKE
7370

@@ -77,23 +74,21 @@ FAKE is only used to run build.fsx. Eventually we will likely remove this once
7774

7875
### Testing
7976

80-
Testing reuses the test files from ..\tests\service which were are also FCS tests.
81-
77+
Testing reuses the test files from ..\tests\service which were are also FCS tests.
8278

8379
### Documentation Generation
8480

8581
fcs\build GenerateDocs
8682

87-
Output is in ``docs``. In the ``FSharp.Compiler.Service`` repo this is checked in and hosted as http://fsharp.github.io/FSharp.Compiler.Service.
88-
83+
Output is in ``docs``. In the ``FSharp.Compiler.Service`` repo this is checked in and hosted as <https://fsharp.github.io/FSharp.Compiler.Service>.
8984

9085
## The two other NuGet packages
9186

92-
It also contains both the source, build, packaging and test logic for
87+
It also contains both the source, build, packaging and test logic for
9388

94-
* ``FSharp.Compiler.Service.MSBuild.v12`` adds legacy MSBuild v12 support to an instance of FSharp.Compiler.Service, if exact compatibility for scripting references such as ``#r "Foo, Version=1.3.4"`` is required.
89+
- ``FSharp.Compiler.Service.MSBuild.v12`` adds legacy MSBuild v12 support to an instance of FSharp.Compiler.Service, if exact compatibility for scripting references such as ``#r "Foo, Version=1.3.4"`` is required.
9590

96-
* ``FSharp.Compiler.Service.ProjectCracker`` is part of ``FsAutoComplete`` and Ionide and is used to crack old-style project formats using MSBuild. It used to be part of the FCS API.
91+
- ``FSharp.Compiler.Service.ProjectCracker`` is part of ``FsAutoComplete`` and Ionide and is used to crack old-style project formats using MSBuild. It used to be part of the FCS API.
9792

9893
Both of these components are gradually becoming obsolete
9994

@@ -102,8 +97,7 @@ Both of these components are gradually becoming obsolete
10297
FSharp.Compiler.Service is a somewhat awkward component. There are some things we can do to simplify things:
10398

10499
1. Remove the use of Paket and FAKE
105-
1. Move all projects under fcs\... to new .NET SDK project file format
100+
1. Move all projects under fcs\... to new .NET SDK project file format
106101
1. Drop the use of ``dotnet mergenupkg`` since we should be able to use cross targeting
107102
1. Make FCS a DLL similar ot the rest of the build and make this an official component from Microsoft (signed etc.)
108103
1. Replace FSharp.Compiler.Private by FSharp.Compiler.Service
109-

0 commit comments

Comments
 (0)