From 4c0dbf08f7f8f12dbaa939c6a1ec52438e288670 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 26 Nov 2018 14:24:21 -0500 Subject: [PATCH 01/10] Script for automatic release notes --- .gitignore | 1 + tools/ReleaseNotes/Program.cs | 316 +++++++++++++++++++++++++ tools/ReleaseNotes/README.md | 7 + tools/ReleaseNotes/ReleaseNotes.csproj | 13 + tools/ReleaseNotes/release_notes.md | 17 ++ 5 files changed, 354 insertions(+) create mode 100644 tools/ReleaseNotes/Program.cs create mode 100644 tools/ReleaseNotes/README.md create mode 100644 tools/ReleaseNotes/ReleaseNotes.csproj create mode 100644 tools/ReleaseNotes/release_notes.md diff --git a/.gitignore b/.gitignore index 20bc8fcd5a..8b0b626b5c 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,4 @@ artifacts/ /tests/DMAPI/travistester.int /tests/DMAPI/travistester.dmb /src/Tgstation.Server.Host/appsettings.Development.json +/tools/ReleaseNotes/release_nodes.md diff --git a/tools/ReleaseNotes/Program.cs b/tools/ReleaseNotes/Program.cs new file mode 100644 index 0000000000..b0219fad6f --- /dev/null +++ b/tools/ReleaseNotes/Program.cs @@ -0,0 +1,316 @@ +using Octokit; +using System; +using System.Collections.Generic; +using System.Globalization; +using System.IO; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace ReleaseNotes +{ + class Program + { + static async Task Main(string[] args) + { + if (args.Length < 1) + { + Console.WriteLine("Missing version argument!"); + return 1; + } + + var versionString = args[0]; + if (!Version.TryParse(versionString, out var version)) + { + Console.WriteLine("Invalid version: " + versionString); + return 2; + } + + var doNotCloseMilestone = args.Length >= 2 && args[1].ToUpperInvariant() == "--NO-CLOSE"; + + const string ReleaseNotesEnvVar = "TGS_RELEASE_NOTES_TOKEN"; + var githubToken = Environment.GetEnvironmentVariable(ReleaseNotesEnvVar); + if (String.IsNullOrWhiteSpace(githubToken)) + { + Console.WriteLine("Missing " + ReleaseNotesEnvVar + " environment variable!"); + return 3; + } + + try + { + var client = new GitHubClient(new ProductHeaderValue("tgs_release_notes")); + client.Credentials = new Credentials(githubToken); + + const string RepoOwner = "tgstation"; + const string RepoName = "tgstation-server"; + + var releasesTask = client.Repository.Release.GetAll(RepoOwner, RepoName); + + Console.WriteLine("Getting pull requests in milestone " + versionString + "..."); + var milestonePRs = await client.Search.SearchIssues(new SearchIssuesRequest + { + Milestone = versionString, + Type = IssueTypeQualifier.PullRequest, + Repos = { { RepoOwner, RepoName } } + }).ConfigureAwait(false); + + if (milestonePRs.IncompleteResults) + { + Console.WriteLine("Incomplete results for milestone PRs query!"); + return 5; + } + Console.WriteLine(milestonePRs.Items.Count + " total pull requests"); + + Task milestoneTask = null; + var milestoneTaskLock = new object(); + var releaseDictionary = new Dictionary>(); + var authorizedUsers = new Dictionary>(); + + async Task GetReleaseNotesFromPR(Issue pullRequest) + { + PullRequest fullPR = null; + async Task GetFullPR() + { + if (fullPR != null) + return; + fullPR = await client.Repository.PullRequest.Get(RepoOwner, RepoName, pullRequest.Number).ConfigureAwait(false); + }; + + async Task GetMilestone() + { + await GetFullPR().ConfigureAwait(false); + if (fullPR.Milestone == null) + return null; + return await client.Issue.Milestone.Get(RepoOwner, RepoName, fullPR.Milestone.Number); + }; + + if (pullRequest.State.Value == ItemState.Closed) + { + //need to check it was merged + lock (milestoneTaskLock) + if (milestoneTask == null) + milestoneTask = GetMilestone(); + if (!fullPR.Merged) + return; + }; + + async Task BuildNotesFromComment(string comment, User user) + { + var commentSplits = comment.Split('\n'); + var notesOpen = false; + var notesClosed = false; + var notes = new List(); + foreach (var line in commentSplits) + { + var trimmedLine = line.Trim(); + if (!notesOpen) + { + notesOpen = trimmedLine.StartsWith(":cl:", StringComparison.Ordinal); + notesClosed = false; + continue; + } + if (trimmedLine.StartsWith("/:cl:", StringComparison.Ordinal)) + { + notesClosed = true; + notesOpen = false; + continue; + } + if (trimmedLine.Length == 0) + continue; + notes.Add(trimmedLine); + } + if (!notesClosed || notes.Count == 0) + return; + + Task authTask; + TaskCompletionSource ourTcs = null; + lock (authorizedUsers) + { + if (!authorizedUsers.TryGetValue(user.Id, out authTask)) + { + ourTcs = new TaskCompletionSource(); + authTask = ourTcs.Task; + authorizedUsers.Add(user.Id, authTask); + } + } + + if (ourTcs != null) + try + { + //check if the user has access + var perm = await client.Repository.Collaborator.ReviewPermission(RepoOwner, RepoName, user.Login).ConfigureAwait(false); + ourTcs.SetResult(perm.Permission == PermissionLevel.Write || perm.Permission == PermissionLevel.Admin); + } + catch + { + ourTcs.SetResult(false); + throw; + } + + var authorized = await authTask.ConfigureAwait(false); + if (!authorized) + return; + + lock (releaseDictionary) + { + foreach (var I in notes) + Console.WriteLine("#" + pullRequest.Number + " - " + I + " (@" + user.Login + ")"); + if (releaseDictionary.TryGetValue(pullRequest.Number, out var currentValues)) + currentValues.AddRange(notes); + else + releaseDictionary.Add(pullRequest.Number, notes); + } + } + + var comments = await client.Issue.Comment.GetAllForIssue(RepoOwner, RepoName, pullRequest.Number).ConfigureAwait(false); + await Task.WhenAll(BuildNotesFromComment(pullRequest.Body, pullRequest.User), Task.WhenAll(comments.Select(x => BuildNotesFromComment(x.Body, x.User)))).ConfigureAwait(false); + + lock (milestoneTaskLock) + if (milestoneTask == null) + milestoneTask = GetMilestone(); + } + + var tasks = new List(); + foreach (var I in milestonePRs.Items) + tasks.Add(GetReleaseNotesFromPR(I)); + + var releases = await releasesTask.ConfigureAwait(false); + + var releasingSuite = version.Major; + + Version highestReleaseVersion = null; + Release highestRelease = null; + foreach (var I in releases) + { + if (!Version.TryParse(I.TagName.Replace("tgstation-server-v", String.Empty), out var currentReleaseVersion)) + { + Console.WriteLine("WARNING: Unable to determine version of release " + I.HtmlUrl); + continue; + } + + if (currentReleaseVersion.Major == releasingSuite && (highestReleaseVersion == null || currentReleaseVersion > highestReleaseVersion)) + { + highestReleaseVersion = currentReleaseVersion; + highestRelease = I; + } + } + + if (highestReleaseVersion == null) + { + Console.WriteLine("Unable to determine highest release version for suite " + releasingSuite + "!"); + return 6; + } + + var oldNotes = highestRelease.Body; + + var splits = new List(oldNotes.Split('\n')); + //trim away all the lines that don't start with # + + string keepThisRelease; + if (version.Revision == 0) + if (version.Build == 0) + keepThisRelease = "# "; + else + keepThisRelease = "## "; + else + keepThisRelease = "### "; + + for (; !splits[0].StartsWith(keepThisRelease, StringComparison.Ordinal); splits.RemoveAt(0)) + if (splits.Count == 1) + { + Console.WriteLine("Error formatting release notes: Can't detemine notes start!"); + return 7; + } + + oldNotes = String.Join('\n', splits); + + string prefix; + switch (releasingSuite) + { + case 3: + prefix = "The /tg/station server suite"; + break; + default: + prefix = "See https://tgstation.github.io/tgstation-server for installation instructions"; + break; + } + + var newNotes = new StringBuilder(prefix); + newNotes.Append(Environment.NewLine); + newNotes.Append(Environment.NewLine); + if (version.Revision == 0) + if (version.Build == 0) + { + newNotes.Append("# [Version "); + newNotes.Append(version.Minor); + } + else + { + newNotes.Append("## [Changelog for "); + newNotes.Append(version.Build); + newNotes.Append(".x"); + } + else + { + newNotes.Append("### [Patch "); + newNotes.Append(version.Revision); + } + newNotes.Append("]("); + var milestone = await milestoneTask.ConfigureAwait(false); + if (milestone == null) + { + Console.WriteLine("Unable to detemine milestone!"); + return 9; + } + newNotes.Append(milestone.HtmlUrl); + newNotes.Append("?closed=1)"); + newNotes.Append(Environment.NewLine); + + await Task.WhenAll(tasks).ConfigureAwait(false); + + if (releaseDictionary.Count == 0) + { + Console.WriteLine("No release notes for this milestone!"); + return 8; + } + + foreach (var I in releaseDictionary) + foreach (var note in I.Value) + { + newNotes.Append(Environment.NewLine); + newNotes.Append("- "); + newNotes.Append(note); + newNotes.Append(" (#"); + newNotes.Append(I.Key); + newNotes.Append(')'); + } + + newNotes.Append(Environment.NewLine); + newNotes.Append(Environment.NewLine); + newNotes.Append(oldNotes); + + Console.WriteLine("Writing out new release notes..."); + var releaseNotes = newNotes.ToString(); + await File.WriteAllTextAsync("release_notes.md", releaseNotes).ConfigureAwait(false); + + if (doNotCloseMilestone) + Console.WriteLine("Not closing milestone due to parameter!"); + else + { + Console.WriteLine("Closing milestone..."); + await client.Issue.Milestone.Update(RepoOwner, RepoName, milestone.Number, new MilestoneUpdate + { + State = ItemState.Closed + }).ConfigureAwait(false); + } + + return 0; + } + catch (Exception e) + { + Console.WriteLine(e); + return 4; + } + } + } +} diff --git a/tools/ReleaseNotes/README.md b/tools/ReleaseNotes/README.md new file mode 100644 index 0000000000..63aa900ef3 --- /dev/null +++ b/tools/ReleaseNotes/README.md @@ -0,0 +1,7 @@ +This is a small tool to generate TGS release notes from PR descriptions + +Requires environment variable `TGS_RELEASE_NOTES_TOKEN` + +Run it with `dotnet run [--no-close (optionally doesn't close the milestone, USE WHILE DEBUGGING)]` + +Will close the release milestone and output `release_notes.md` with the updated release notes diff --git a/tools/ReleaseNotes/ReleaseNotes.csproj b/tools/ReleaseNotes/ReleaseNotes.csproj new file mode 100644 index 0000000000..64c79d0620 --- /dev/null +++ b/tools/ReleaseNotes/ReleaseNotes.csproj @@ -0,0 +1,13 @@ + + + + Exe + netcoreapp2.1 + latest + + + + + + + diff --git a/tools/ReleaseNotes/release_notes.md b/tools/ReleaseNotes/release_notes.md new file mode 100644 index 0000000000..25c9366336 --- /dev/null +++ b/tools/ReleaseNotes/release_notes.md @@ -0,0 +1,17 @@ +See https://tgstation.github.io/tgstation-server for installation instructions + +## [Changelog for 2.x](https://github.com/tgstation/tgstation-server/milestone/13?closed=1) + +- Added `/datum/tgs_version` to the DMAPI. `/world/TgsVersion()`, `/world/TgsMaximumAPIVersion()`, and `/world/TgsMinimumAPIVersion()` now return this datum (#827) + +## [Changelog for 1.X](https://github.com/tgstation/tgstation-server/milestone/11?closed=1) + +- Added the command line setup wizard. No more need to configure `appsettings.Production.json` manually +- You can now ignore files and folder for symlinking in the `GameStaticFiles` directory using the `.tgsignore` file +- If the repository is configured with valid GitHub synchronization credentials, the user account will now post [test merge comments](https://github.com/tgstation/tgstation/pull/40735#issuecomment-427503427) [when deployments involving them happen](https://github.com/tgstation/tgstation/pull/40736#issuecomment-427503428) +- Releases now contain a `.zip` of the latest DMAPI files +- Installing DirectX on Windows is no longer required for BYOND versions >= 512.1452 +- Updating the server should no longer timeout clients +- Various kinks were ironed out in internal systems + +# [Initial Release](https://github.com/tgstation/tgstation-server/milestone/3?closed=1) \ No newline at end of file From 1f5d14d047440b453aaa16875b88d0ed5bc3b4d7 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 26 Nov 2018 14:24:32 -0500 Subject: [PATCH 02/10] Test on CI --- appveyor.yml | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/appveyor.yml b/appveyor.yml index bb91fa6517..b77db8d363 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -6,6 +6,8 @@ environment: TGS4_TEST_CONNECTION_STRING: Server=(local)\SQL2017;Initial Catalog=TGS_Test;User ID=sa;Password=Password12! TGS4_TEST_GITHUB_TOKEN: secure: lJNGAXwiB5HlWdthz3K4PetqpTG5IEAyRgKaiKxFMQ8HW8CcOjRtB97B05op7BsK + TGS_RELEASE_NOTES_TOKEN: + secure: lJNGAXwiB5HlWdthz3K4PetqpTG5IEAyRgKaiKxFMQ8HW8CcOjRtB97B05op7BsK branches: only: - master @@ -80,14 +82,19 @@ after_test: - ps: $env:TGSVersion = [System.Diagnostics.FileVersionInfo]::GetVersionInfo("$env:APPVEYOR_BUILD_FOLDER/artifacts/ServerHost/Tgstation.Server.Host.dll").FileVersion - ps: if($env:APPVEYOR_REPO_COMMIT_MESSAGE -match "\[TGSDeploy\]"){ if($env:APPVEYOR_REPO_BRANCH -match "master"){ if($env:CONFIGURATION -match "Release"){ $env:TGSDeploy = "Do it." }}} - ps: if($env:APPVEYOR_REPO_COMMIT_MESSAGE -match "\[NugetDeploy\]"){ if($env:APPVEYOR_REPO_BRANCH -match "master"){ if($env:CONFIGURATION -match "Release"){ $env:NugetDeploy = "Do it." }}} + - ps: $env:TGSGoodNotes = (Start-Process -FilePath 'dotnet' -ArgumentList "run -p tools/ReleaseNotes 4.0.2.0 --no-close" -PassThru -Wait).ExitCode + - ps: $env:TGSReleaseNotes = [IO.File]::ReadAllText("tools/ReleaseNotes/release_notes.md") + - ps: Write-Host $env:TGSReleaseNotes + - ps: Write-Host $env:TGSGoodNotes deploy: - provider: GitHub release: "tgstation-server-v$(TGSVersion)" - description: 'The /tg/station server suite' + description: "$(TGSReleaseNotes)" auth_token: secure: lJNGAXwiB5HlWdthz3K4PetqpTG5IEAyRgKaiKxFMQ8HW8CcOjRtB97B05op7BsK artifact: ServerConsole,ServerService,ServerUpdatePackage,DMAPI - draft: true + draft: $(TGSGoodNotes) + prerelease: true on: TGSDeploy: "Do it." - provider: NuGet From ae880389fe4b38087c03f50dd9cae2acfb64d885 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 26 Nov 2018 14:43:22 -0500 Subject: [PATCH 03/10] Just use a script actually --- appveyor.yml | 4 +--- build/prep_deployment.ps1 | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 build/prep_deployment.ps1 diff --git a/appveyor.yml b/appveyor.yml index b77db8d363..bd91b5dee0 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -79,9 +79,7 @@ after_test: - ps: Move-Item -path artifacts/ServerService/lib/Default/appsettings.json -destination artifacts/ServerService/ - ps: Remove-Item artifacts/ServerHost/appsettings.json #deploy stuff - - ps: $env:TGSVersion = [System.Diagnostics.FileVersionInfo]::GetVersionInfo("$env:APPVEYOR_BUILD_FOLDER/artifacts/ServerHost/Tgstation.Server.Host.dll").FileVersion - - ps: if($env:APPVEYOR_REPO_COMMIT_MESSAGE -match "\[TGSDeploy\]"){ if($env:APPVEYOR_REPO_BRANCH -match "master"){ if($env:CONFIGURATION -match "Release"){ $env:TGSDeploy = "Do it." }}} - - ps: if($env:APPVEYOR_REPO_COMMIT_MESSAGE -match "\[NugetDeploy\]"){ if($env:APPVEYOR_REPO_BRANCH -match "master"){ if($env:CONFIGURATION -match "Release"){ $env:NugetDeploy = "Do it." }}} + - ps: build/prep_deployment.ps1 - ps: $env:TGSGoodNotes = (Start-Process -FilePath 'dotnet' -ArgumentList "run -p tools/ReleaseNotes 4.0.2.0 --no-close" -PassThru -Wait).ExitCode - ps: $env:TGSReleaseNotes = [IO.File]::ReadAllText("tools/ReleaseNotes/release_notes.md") - ps: Write-Host $env:TGSReleaseNotes diff --git a/build/prep_deployment.ps1 b/build/prep_deployment.ps1 new file mode 100644 index 0000000000..7871c6266a --- /dev/null +++ b/build/prep_deployment.ps1 @@ -0,0 +1,19 @@ +$env:TGSVersion = [System.Diagnostics.FileVersionInfo]::GetVersionInfo("$env:APPVEYOR_BUILD_FOLDER/artifacts/ServerHost/Tgstation.Server.Host.dll").FileVersion +if (($env:CONFIGURATION -match "Release") -And ($env:APPVEYOR_REPO_BRANCH -match "master")) { + if ($env:APPVEYOR_REPO_COMMIT_MESSAGE -match "\[TGSDeploy\]") { + $env:TGSDeploy = "Do it." + } + if ($env:APPVEYOR_REPO_COMMIT_MESSAGE -match "\[NugetDeploy\]") { + $env:NugetDeploy = "Do it." + } +} + +dotnet run -p tools/ReleaseNotes $env:TGSVersion --no-close +$env:TGSGoodNotes = $? +$releaseNotesPath = "tools/ReleaseNotes/release_notes.md" +if (Test-Path $path -PathType $releaseNotesPath) { + $env:TGSReleaseNotes = [IO.File]::ReadAllText($releaseNotesPath) +} +else { + $env:TGSReleaseNotes = "Automatic generation failed, please fill manually!" +} From eabdb9ea3af70baab92f007a4588e3c6da5a3952 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 26 Nov 2018 14:44:07 -0500 Subject: [PATCH 04/10] Remove this stuff --- appveyor.yml | 28 ---------------------------- 1 file changed, 28 deletions(-) diff --git a/appveyor.yml b/appveyor.yml index bd91b5dee0..f7dece7815 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -40,33 +40,7 @@ build: parallel: false verbosity: minimal publish_nuget: true -test_script: - - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Api.Tests/Tgstation.Server.Api.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Api.Tests*]*" -output:".\api_coverage.xml" -oldstyle - - ps: $wc = New-Object 'System.Net.WebClient' - - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Api.Tests\TestResults\results.trx)) - - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Client.Tests/Tgstation.Server.Client.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Client.Tests*]*" -output:".\client_coverage.xml" -oldstyle - - ps: $wc = New-Object 'System.Net.WebClient' - - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Client.Tests\TestResults\results.trx)) - - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Host.Tests/Tgstation.Server.Host.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Host.Tests*]* -[Tgstation.Server.Host]Tgstation.Server.Host.Models.Migrations*" -output:".\host_coverage.xml" -oldstyle - - ps: $wc = New-Object 'System.Net.WebClient' - - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Host.Tests\TestResults\results.trx)) - - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Host.Console.Tests/Tgstation.Server.Host.Console.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Host.Console.Tests*]*" -output:".\console_coverage.xml" -oldstyle - - ps: $wc = New-Object 'System.Net.WebClient' - - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Host.Console.Tests\TestResults\results.trx)) - - set path=%ProgramFiles(x86)%\Microsoft Visual Studio\2017\TestAgent\Common7\IDE\CommonExtensions\Microsoft\TestWindow;%path% - - copy "%ProgramFiles(x86)%\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TestWindow\Extensions\appveyor.*" "%ProgramFiles(x86)%\Microsoft Visual Studio\2017\TestAgent\Common7\IDE\CommonExtensions\Microsoft\TestWindow\Extensions" /y - - vstest.console /logger:trx;LogFileName=results.trx "tests\Tgstation.Server.Host.Service.Tests\bin\%CONFIGURATION%\Tgstation.Server.Host.Service.Tests.dll" /Enablecodecoverage /inIsolation /Platform:x64 - - ps: $wc = New-Object 'System.Net.WebClient' - - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\TestResults\results.trx)) - - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Host.Watchdog.Tests/Tgstation.Server.Host.Watchdog.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Host.Watchdog.Tests*]*" -output:".\watchdog_coverage.xml" -oldstyle - - ps: $wc = New-Object 'System.Net.WebClient' - - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Host.Watchdog.Tests\TestResults\results.trx)) - - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Tests/Tgstation.Server.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Tests*]* -[Tgstation.Server.Host]Tgstation.Server.Host.Models.Migrations..*" -output:".\server_coverage.xml" -oldstyle - - ps: $wc = New-Object 'System.Net.WebClient' - - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Tests\TestResults\results.trx)) after_test: - - ps: build/UploadCoverage.ps1 - - ps: build/BuildDox.ps1 #host updater - dotnet publish src/Tgstation.Server.Host/Tgstation.Server.Host.csproj -o ../../artifacts/ServerHost -c %CONFIGURATION% #console @@ -80,8 +54,6 @@ after_test: - ps: Remove-Item artifacts/ServerHost/appsettings.json #deploy stuff - ps: build/prep_deployment.ps1 - - ps: $env:TGSGoodNotes = (Start-Process -FilePath 'dotnet' -ArgumentList "run -p tools/ReleaseNotes 4.0.2.0 --no-close" -PassThru -Wait).ExitCode - - ps: $env:TGSReleaseNotes = [IO.File]::ReadAllText("tools/ReleaseNotes/release_notes.md") - ps: Write-Host $env:TGSReleaseNotes - ps: Write-Host $env:TGSGoodNotes deploy: From 0d7e17a489e6498438a1aedeea9f404e0295114b Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 26 Nov 2018 14:51:15 -0500 Subject: [PATCH 05/10] Fix bug in release notes script --- tools/ReleaseNotes/Program.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/tools/ReleaseNotes/Program.cs b/tools/ReleaseNotes/Program.cs index b0219fad6f..335d752201 100644 --- a/tools/ReleaseNotes/Program.cs +++ b/tools/ReleaseNotes/Program.cs @@ -87,6 +87,7 @@ namespace ReleaseNotes if (pullRequest.State.Value == ItemState.Closed) { //need to check it was merged + await GetFullPR().ConfigureAwait(false); lock (milestoneTaskLock) if (milestoneTask == null) milestoneTask = GetMilestone(); From d389e6250f3e9dc26b76493c552e3a9a9d7adea1 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 26 Nov 2018 14:53:28 -0500 Subject: [PATCH 06/10] Fix this too --- build/prep_deployment.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build/prep_deployment.ps1 b/build/prep_deployment.ps1 index 7871c6266a..7df3c51b60 100644 --- a/build/prep_deployment.ps1 +++ b/build/prep_deployment.ps1 @@ -11,7 +11,7 @@ if (($env:CONFIGURATION -match "Release") -And ($env:APPVEYOR_REPO_BRANCH -match dotnet run -p tools/ReleaseNotes $env:TGSVersion --no-close $env:TGSGoodNotes = $? $releaseNotesPath = "tools/ReleaseNotes/release_notes.md" -if (Test-Path $path -PathType $releaseNotesPath) { +if (Test-Path $releaseNotesPath -PathType Leaf) { $env:TGSReleaseNotes = [IO.File]::ReadAllText($releaseNotesPath) } else { From 8c2bfc425044792f411f44a09e11f5ae76729222 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 26 Nov 2018 14:55:05 -0500 Subject: [PATCH 07/10] Other cleanups --- build/prep_deployment.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/build/prep_deployment.ps1 b/build/prep_deployment.ps1 index 7df3c51b60..180319e02a 100644 --- a/build/prep_deployment.ps1 +++ b/build/prep_deployment.ps1 @@ -8,9 +8,9 @@ if (($env:CONFIGURATION -match "Release") -And ($env:APPVEYOR_REPO_BRANCH -match } } -dotnet run -p tools/ReleaseNotes $env:TGSVersion --no-close +dotnet run -p "$env:APPVEYOR_BUILD_FOLDER/tools/ReleaseNotes" $env:TGSVersion --no-close $env:TGSGoodNotes = $? -$releaseNotesPath = "tools/ReleaseNotes/release_notes.md" +$releaseNotesPath = "$env:APPVEYOR_BUILD_FOLDER/tools/ReleaseNotes/release_notes.md" if (Test-Path $releaseNotesPath -PathType Leaf) { $env:TGSReleaseNotes = [IO.File]::ReadAllText($releaseNotesPath) } From 576f1683e39f788cd9fc36d0d3b01c9375528671 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 26 Nov 2018 15:13:01 -0500 Subject: [PATCH 08/10] I need to TEST --- build/prep_deployment.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build/prep_deployment.ps1 b/build/prep_deployment.ps1 index 180319e02a..3f1b84ac60 100644 --- a/build/prep_deployment.ps1 +++ b/build/prep_deployment.ps1 @@ -8,7 +8,7 @@ if (($env:CONFIGURATION -match "Release") -And ($env:APPVEYOR_REPO_BRANCH -match } } -dotnet run -p "$env:APPVEYOR_BUILD_FOLDER/tools/ReleaseNotes" $env:TGSVersion --no-close +dotnet run -p "$env:APPVEYOR_BUILD_FOLDER/tools/ReleaseNotes" 4.0.2.0 --no-close $env:TGSGoodNotes = $? $releaseNotesPath = "$env:APPVEYOR_BUILD_FOLDER/tools/ReleaseNotes/release_notes.md" if (Test-Path $releaseNotesPath -PathType Leaf) { From 93ab39abb41bafaa799ee932546ea7f8853a55d5 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 26 Nov 2018 15:28:58 -0500 Subject: [PATCH 09/10] Cleanup --- .github/CONTRIBUTING.md | 25 ++ .github/PULL_REQUEST_TEMPLATE.md | 13 + appveyor.yml | 30 +- build/prep_deployment.ps1 | 34 +- tools/ReleaseNotes/Program.cs | 524 +++++++++++++++---------------- 5 files changed, 343 insertions(+), 283 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e1c6d6cf23..19273f5d99 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -149,7 +149,32 @@ There is no strict process when it comes to merging pull requests. Pull requests * Commits MUST be properly titled and commented as we only use merge commits for the pull request process +## Deployment process + +Every issue/pull request in a release should share a common milestone named with the release version i.e. `4.5.3.5` + +When every issue and PR in the milestone is closed. Create a version bump PR that changes the version numbers. At the time of this writing they exist in the following files + +- `/src/Tgstation.Server.Host/Tgstation.Server.Host.csproj` +- `/src/Tgstation.Server.Host.Console/Tgstation.Server.Host.Console.csproj` +- 2 in `/src/Tgstation.Server.Host.Service/Properties/AssemblyInfo.cs` +- `/src/Tgstation.Server.Host.Watchdog/Tgstation.Server.Host.Watchdog.csproj` + +Merge the pull request with `[TGSDeploy]` somewhere in the commit title. The scripts will handle amalgamating release notes, building, closing the milestone, and publishing the release. This will also trigger update notifications on existing TGS deployments. + +### API/Client Deployment + +The Api/Client project versions must be updated on nuget when changed. The numbers exist in the following files: + +- `/src/Tgstation.Server.Api/Tgstation.Server.Api.csproj` +- `/src/Tgstation.Server.Client/Tgstation.Server.Client.csproj` + +These should not be the same numbers as the main suite. When bumping the API version the client should only receive a minor (3rd number) version bump unless major changes to CLIENT code were made. + +Merge these alongside regular deployments with `[NugetDeploy]` in the commit title (Won't work without an accompanying `[TGSDeploy]`). This will handle the nuget publishing. + ## Banned content + Do not add any of the following in a Pull Request or risk getting the PR closed: * National Socialist Party of Germany content, National Socialist Party of Germany related content, or National Socialist Party of Germany references diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..98fe22ab33 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +[Release Notes]: # (Your PR should contain a detailed list of notable changes, titled appropriately. This includes any observable changes to the server or DMAPI. See example below) + +:cl: +Description of your change +Each newline corresponds to a release note in the upcoming sprint +/:cl: + +:cl: +You can also have multiple sets of release notes per pull request +They will be amalgamated together in the end +/:cl: + +[Why]: # (Please add a short description [two lines down] of why you think these changes would benefit the game. If you can't justify it in words, it might not be worth adding.) diff --git a/appveyor.yml b/appveyor.yml index f7dece7815..5b94661a3e 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -40,7 +40,33 @@ build: parallel: false verbosity: minimal publish_nuget: true +test_script: + - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Api.Tests/Tgstation.Server.Api.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Api.Tests*]*" -output:".\api_coverage.xml" -oldstyle + - ps: $wc = New-Object 'System.Net.WebClient' + - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Api.Tests\TestResults\results.trx)) + - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Client.Tests/Tgstation.Server.Client.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Client.Tests*]*" -output:".\client_coverage.xml" -oldstyle + - ps: $wc = New-Object 'System.Net.WebClient' + - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Client.Tests\TestResults\results.trx)) + - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Host.Tests/Tgstation.Server.Host.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Host.Tests*]* -[Tgstation.Server.Host]Tgstation.Server.Host.Models.Migrations*" -output:".\host_coverage.xml" -oldstyle + - ps: $wc = New-Object 'System.Net.WebClient' + - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Host.Tests\TestResults\results.trx)) + - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Host.Console.Tests/Tgstation.Server.Host.Console.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Host.Console.Tests*]*" -output:".\console_coverage.xml" -oldstyle + - ps: $wc = New-Object 'System.Net.WebClient' + - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Host.Console.Tests\TestResults\results.trx)) + - set path=%ProgramFiles(x86)%\Microsoft Visual Studio\2017\TestAgent\Common7\IDE\CommonExtensions\Microsoft\TestWindow;%path% + - copy "%ProgramFiles(x86)%\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TestWindow\Extensions\appveyor.*" "%ProgramFiles(x86)%\Microsoft Visual Studio\2017\TestAgent\Common7\IDE\CommonExtensions\Microsoft\TestWindow\Extensions" /y + - vstest.console /logger:trx;LogFileName=results.trx "tests\Tgstation.Server.Host.Service.Tests\bin\%CONFIGURATION%\Tgstation.Server.Host.Service.Tests.dll" /Enablecodecoverage /inIsolation /Platform:x64 + - ps: $wc = New-Object 'System.Net.WebClient' + - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\TestResults\results.trx)) + - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Host.Watchdog.Tests/Tgstation.Server.Host.Watchdog.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Host.Watchdog.Tests*]*" -output:".\watchdog_coverage.xml" -oldstyle + - ps: $wc = New-Object 'System.Net.WebClient' + - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Host.Watchdog.Tests\TestResults\results.trx)) + - OpenCover.Console.exe -returntargetcode -register:user -target:"C:/Program Files/dotnet/dotnet.exe" -targetargs:"test -c %CONFIGURATION% --logger:trx;LogFileName=results.trx /p:DebugType=full tests/Tgstation.Server.Tests/Tgstation.Server.Tests.csproj" -filter:"+[Tgstation.Server*]* -[Tgstation.Server.Tests*]* -[Tgstation.Server.Host]Tgstation.Server.Host.Models.Migrations..*" -output:".\server_coverage.xml" -oldstyle + - ps: $wc = New-Object 'System.Net.WebClient' + - ps: $wc.UploadFile("https://ci.appveyor.com/api/testresults/mstest/$($env:APPVEYOR_JOB_ID)", (Resolve-Path .\tests\Tgstation.Server.Tests\TestResults\results.trx)) after_test: + - ps: build/UploadCoverage.ps1 + - ps: build/BuildDox.ps1 #host updater - dotnet publish src/Tgstation.Server.Host/Tgstation.Server.Host.csproj -o ../../artifacts/ServerHost -c %CONFIGURATION% #console @@ -54,8 +80,6 @@ after_test: - ps: Remove-Item artifacts/ServerHost/appsettings.json #deploy stuff - ps: build/prep_deployment.ps1 - - ps: Write-Host $env:TGSReleaseNotes - - ps: Write-Host $env:TGSGoodNotes deploy: - provider: GitHub release: "tgstation-server-v$(TGSVersion)" @@ -63,7 +87,7 @@ deploy: auth_token: secure: lJNGAXwiB5HlWdthz3K4PetqpTG5IEAyRgKaiKxFMQ8HW8CcOjRtB97B05op7BsK artifact: ServerConsole,ServerService,ServerUpdatePackage,DMAPI - draft: $(TGSGoodNotes) + draft: $(TGSDraftNotes) prerelease: true on: TGSDeploy: "Do it." diff --git a/build/prep_deployment.ps1 b/build/prep_deployment.ps1 index 3f1b84ac60..a00431bff8 100644 --- a/build/prep_deployment.ps1 +++ b/build/prep_deployment.ps1 @@ -1,19 +1,25 @@ $env:TGSVersion = [System.Diagnostics.FileVersionInfo]::GetVersionInfo("$env:APPVEYOR_BUILD_FOLDER/artifacts/ServerHost/Tgstation.Server.Host.dll").FileVersion -if (($env:CONFIGURATION -match "Release") -And ($env:APPVEYOR_REPO_BRANCH -match "master")) { - if ($env:APPVEYOR_REPO_COMMIT_MESSAGE -match "\[TGSDeploy\]") { - $env:TGSDeploy = "Do it." + +Write-Host "TGS Version: $env:TGSVersion" + +if (($env:CONFIGURATION -match "Release") -And ($env:APPVEYOR_REPO_BRANCH -match "master") -And ($env:APPVEYOR_REPO_COMMIT_MESSAGE -match "\[TGSDeploy\]")) { + Write-Host "Deploying..." + $env:TGSDeploy = "Do it." + + Write-Host "Generating release notes..." + dotnet run -p "$env:APPVEYOR_BUILD_FOLDER/tools/ReleaseNotes" $env:TGSVersion + $env:TGSDraftNotes = !($?) + $releaseNotesPath = "$env:APPVEYOR_BUILD_FOLDER/tools/ReleaseNotes/release_notes.md" + if (Test-Path $releaseNotesPath -PathType Leaf) { + $env:TGSReleaseNotes = [IO.File]::ReadAllText($releaseNotesPath) } + else { + Write-Host "Release note generation failed, release will be created as a draft!" + $env:TGSReleaseNotes = "Automatic generation failed, please fill manually!" + } + if ($env:APPVEYOR_REPO_COMMIT_MESSAGE -match "\[NugetDeploy\]") { $env:NugetDeploy = "Do it." - } -} - -dotnet run -p "$env:APPVEYOR_BUILD_FOLDER/tools/ReleaseNotes" 4.0.2.0 --no-close -$env:TGSGoodNotes = $? -$releaseNotesPath = "$env:APPVEYOR_BUILD_FOLDER/tools/ReleaseNotes/release_notes.md" -if (Test-Path $releaseNotesPath -PathType Leaf) { - $env:TGSReleaseNotes = [IO.File]::ReadAllText($releaseNotesPath) -} -else { - $env:TGSReleaseNotes = "Automatic generation failed, please fill manually!" + Write-Host "Nuget deployment enabled" + } } diff --git a/tools/ReleaseNotes/Program.cs b/tools/ReleaseNotes/Program.cs index 335d752201..edd1960dd5 100644 --- a/tools/ReleaseNotes/Program.cs +++ b/tools/ReleaseNotes/Program.cs @@ -9,309 +9,301 @@ using System.Threading.Tasks; namespace ReleaseNotes { - class Program - { - static async Task Main(string[] args) - { - if (args.Length < 1) - { - Console.WriteLine("Missing version argument!"); - return 1; - } + /// + /// Contains the application entrypoint + /// + static class Program + { + /// + /// The entrypoint for the + /// + static async Task Main(string[] args) + { + if (args.Length < 1) + { + Console.WriteLine("Missing version argument!"); + return 1; + } - var versionString = args[0]; - if (!Version.TryParse(versionString, out var version)) - { - Console.WriteLine("Invalid version: " + versionString); - return 2; - } + var versionString = args[0]; + if (!Version.TryParse(versionString, out var version)) + { + Console.WriteLine("Invalid version: " + versionString); + return 2; + } - var doNotCloseMilestone = args.Length >= 2 && args[1].ToUpperInvariant() == "--NO-CLOSE"; + var doNotCloseMilestone = args.Length >= 2 && args[1].ToUpperInvariant() == "--NO-CLOSE"; - const string ReleaseNotesEnvVar = "TGS_RELEASE_NOTES_TOKEN"; - var githubToken = Environment.GetEnvironmentVariable(ReleaseNotesEnvVar); - if (String.IsNullOrWhiteSpace(githubToken)) - { - Console.WriteLine("Missing " + ReleaseNotesEnvVar + " environment variable!"); - return 3; - } + const string ReleaseNotesEnvVar = "TGS_RELEASE_NOTES_TOKEN"; + var githubToken = Environment.GetEnvironmentVariable(ReleaseNotesEnvVar); + if (String.IsNullOrWhiteSpace(githubToken)) + { + Console.WriteLine("Missing " + ReleaseNotesEnvVar + " environment variable!"); + return 3; + } - try - { - var client = new GitHubClient(new ProductHeaderValue("tgs_release_notes")); - client.Credentials = new Credentials(githubToken); + try + { + var client = new GitHubClient(new ProductHeaderValue("tgs_release_notes")); + client.Credentials = new Credentials(githubToken); - const string RepoOwner = "tgstation"; - const string RepoName = "tgstation-server"; + const string RepoOwner = "tgstation"; + const string RepoName = "tgstation-server"; - var releasesTask = client.Repository.Release.GetAll(RepoOwner, RepoName); + var releasesTask = client.Repository.Release.GetAll(RepoOwner, RepoName); - Console.WriteLine("Getting pull requests in milestone " + versionString + "..."); - var milestonePRs = await client.Search.SearchIssues(new SearchIssuesRequest - { - Milestone = versionString, - Type = IssueTypeQualifier.PullRequest, - Repos = { { RepoOwner, RepoName } } - }).ConfigureAwait(false); + Console.WriteLine("Getting pull requests in milestone " + versionString + "..."); + var milestonePRs = await client.Search.SearchIssues(new SearchIssuesRequest + { + Milestone = versionString, + Type = IssueTypeQualifier.PullRequest, + Repos = { { RepoOwner, RepoName } } + }).ConfigureAwait(false); - if (milestonePRs.IncompleteResults) - { - Console.WriteLine("Incomplete results for milestone PRs query!"); - return 5; - } - Console.WriteLine(milestonePRs.Items.Count + " total pull requests"); + if (milestonePRs.IncompleteResults) + { + Console.WriteLine("Incomplete results for milestone PRs query!"); + return 5; + } + Console.WriteLine(milestonePRs.Items.Count + " total pull requests"); - Task milestoneTask = null; - var milestoneTaskLock = new object(); - var releaseDictionary = new Dictionary>(); - var authorizedUsers = new Dictionary>(); + Task milestoneTask = null; + var milestoneTaskLock = new object(); + var releaseDictionary = new Dictionary>(); + var authorizedUsers = new Dictionary>(); - async Task GetReleaseNotesFromPR(Issue pullRequest) - { - PullRequest fullPR = null; - async Task GetFullPR() - { - if (fullPR != null) - return; - fullPR = await client.Repository.PullRequest.Get(RepoOwner, RepoName, pullRequest.Number).ConfigureAwait(false); - }; + async Task GetReleaseNotesFromPR(Issue pullRequest) + { + //need to check it was merged + var fullPr = await client.Repository.PullRequest.Get(RepoOwner, RepoName, pullRequest.Number).ConfigureAwait(false); - async Task GetMilestone() - { - await GetFullPR().ConfigureAwait(false); - if (fullPR.Milestone == null) - return null; - return await client.Issue.Milestone.Get(RepoOwner, RepoName, fullPR.Milestone.Number); - }; + async Task GetMilestone() + { + if (fullPR.Milestone == null) + return null; + return await client.Issue.Milestone.Get(RepoOwner, RepoName, fullPR.Milestone.Number); + }; - if (pullRequest.State.Value == ItemState.Closed) - { - //need to check it was merged - await GetFullPR().ConfigureAwait(false); - lock (milestoneTaskLock) - if (milestoneTask == null) - milestoneTask = GetMilestone(); - if (!fullPR.Merged) - return; - }; + lock (milestoneTaskLock) + if (milestoneTask == null) + milestoneTask = GetMilestone(); - async Task BuildNotesFromComment(string comment, User user) - { - var commentSplits = comment.Split('\n'); - var notesOpen = false; - var notesClosed = false; - var notes = new List(); - foreach (var line in commentSplits) - { - var trimmedLine = line.Trim(); - if (!notesOpen) - { - notesOpen = trimmedLine.StartsWith(":cl:", StringComparison.Ordinal); - notesClosed = false; - continue; - } - if (trimmedLine.StartsWith("/:cl:", StringComparison.Ordinal)) - { - notesClosed = true; - notesOpen = false; - continue; - } - if (trimmedLine.Length == 0) - continue; - notes.Add(trimmedLine); - } - if (!notesClosed || notes.Count == 0) - return; + if (!fullPR.Merged) + return; - Task authTask; - TaskCompletionSource ourTcs = null; - lock (authorizedUsers) - { - if (!authorizedUsers.TryGetValue(user.Id, out authTask)) - { - ourTcs = new TaskCompletionSource(); - authTask = ourTcs.Task; - authorizedUsers.Add(user.Id, authTask); - } - } + async Task BuildNotesFromComment(string comment, User user) + { + var commentSplits = comment.Split('\n'); + var notesOpen = false; + var notesClosed = false; + var notes = new List(); + foreach (var line in commentSplits) + { + var trimmedLine = line.Trim(); + if (!notesOpen) + { + notesOpen = trimmedLine.StartsWith(":cl:", StringComparison.Ordinal); + notesClosed = false; + continue; + } + if (trimmedLine.StartsWith("/:cl:", StringComparison.Ordinal)) + { + notesClosed = true; + notesOpen = false; + continue; + } + if (trimmedLine.Length == 0) + continue; + notes.Add(trimmedLine); + } + if (!notesClosed || notes.Count == 0) + return; - if (ourTcs != null) - try - { - //check if the user has access - var perm = await client.Repository.Collaborator.ReviewPermission(RepoOwner, RepoName, user.Login).ConfigureAwait(false); - ourTcs.SetResult(perm.Permission == PermissionLevel.Write || perm.Permission == PermissionLevel.Admin); - } - catch - { - ourTcs.SetResult(false); - throw; - } + Task authTask; + TaskCompletionSource ourTcs = null; + lock (authorizedUsers) + { + if (!authorizedUsers.TryGetValue(user.Id, out authTask)) + { + ourTcs = new TaskCompletionSource(); + authTask = ourTcs.Task; + authorizedUsers.Add(user.Id, authTask); + } + } - var authorized = await authTask.ConfigureAwait(false); - if (!authorized) - return; + if (ourTcs != null) + try + { + //check if the user has access + var perm = await client.Repository.Collaborator.ReviewPermission(RepoOwner, RepoName, user.Login).ConfigureAwait(false); + ourTcs.SetResult(perm.Permission == PermissionLevel.Write || perm.Permission == PermissionLevel.Admin); + } + catch + { + ourTcs.SetResult(false); + throw; + } - lock (releaseDictionary) - { - foreach (var I in notes) - Console.WriteLine("#" + pullRequest.Number + " - " + I + " (@" + user.Login + ")"); - if (releaseDictionary.TryGetValue(pullRequest.Number, out var currentValues)) - currentValues.AddRange(notes); - else - releaseDictionary.Add(pullRequest.Number, notes); - } - } + var authorized = await authTask.ConfigureAwait(false); + if (!authorized) + return; - var comments = await client.Issue.Comment.GetAllForIssue(RepoOwner, RepoName, pullRequest.Number).ConfigureAwait(false); - await Task.WhenAll(BuildNotesFromComment(pullRequest.Body, pullRequest.User), Task.WhenAll(comments.Select(x => BuildNotesFromComment(x.Body, x.User)))).ConfigureAwait(false); + lock (releaseDictionary) + { + foreach (var I in notes) + Console.WriteLine("#" + pullRequest.Number + " - " + I + " (@" + user.Login + ")"); + if (releaseDictionary.TryGetValue(pullRequest.Number, out var currentValues)) + currentValues.AddRange(notes); + else + releaseDictionary.Add(pullRequest.Number, notes); + } + } - lock (milestoneTaskLock) - if (milestoneTask == null) - milestoneTask = GetMilestone(); - } + var comments = await client.Issue.Comment.GetAllForIssue(RepoOwner, RepoName, pullRequest.Number).ConfigureAwait(false); + await Task.WhenAll(BuildNotesFromComment(pullRequest.Body, pullRequest.User), Task.WhenAll(comments.Select(x => BuildNotesFromComment(x.Body, x.User)))).ConfigureAwait(false); + } - var tasks = new List(); - foreach (var I in milestonePRs.Items) - tasks.Add(GetReleaseNotesFromPR(I)); + var tasks = new List(); + foreach (var I in milestonePRs.Items) + tasks.Add(GetReleaseNotesFromPR(I)); - var releases = await releasesTask.ConfigureAwait(false); + var releases = await releasesTask.ConfigureAwait(false); - var releasingSuite = version.Major; + var releasingSuite = version.Major; - Version highestReleaseVersion = null; - Release highestRelease = null; - foreach (var I in releases) - { - if (!Version.TryParse(I.TagName.Replace("tgstation-server-v", String.Empty), out var currentReleaseVersion)) - { - Console.WriteLine("WARNING: Unable to determine version of release " + I.HtmlUrl); - continue; - } + Version highestReleaseVersion = null; + Release highestRelease = null; + foreach (var I in releases) + { + if (!Version.TryParse(I.TagName.Replace("tgstation-server-v", String.Empty), out var currentReleaseVersion)) + { + Console.WriteLine("WARNING: Unable to determine version of release " + I.HtmlUrl); + continue; + } - if (currentReleaseVersion.Major == releasingSuite && (highestReleaseVersion == null || currentReleaseVersion > highestReleaseVersion)) - { - highestReleaseVersion = currentReleaseVersion; - highestRelease = I; - } - } + if (currentReleaseVersion.Major == releasingSuite && (highestReleaseVersion == null || currentReleaseVersion > highestReleaseVersion)) + { + highestReleaseVersion = currentReleaseVersion; + highestRelease = I; + } + } - if (highestReleaseVersion == null) - { - Console.WriteLine("Unable to determine highest release version for suite " + releasingSuite + "!"); - return 6; - } + if (highestReleaseVersion == null) + { + Console.WriteLine("Unable to determine highest release version for suite " + releasingSuite + "!"); + return 6; + } - var oldNotes = highestRelease.Body; + var oldNotes = highestRelease.Body; - var splits = new List(oldNotes.Split('\n')); - //trim away all the lines that don't start with # + var splits = new List(oldNotes.Split('\n')); + //trim away all the lines that don't start with # - string keepThisRelease; - if (version.Revision == 0) - if (version.Build == 0) - keepThisRelease = "# "; - else - keepThisRelease = "## "; - else - keepThisRelease = "### "; + string keepThisRelease; + if (version.Revision == 0) + if (version.Build == 0) + keepThisRelease = "# "; + else + keepThisRelease = "## "; + else + keepThisRelease = "### "; - for (; !splits[0].StartsWith(keepThisRelease, StringComparison.Ordinal); splits.RemoveAt(0)) - if (splits.Count == 1) - { - Console.WriteLine("Error formatting release notes: Can't detemine notes start!"); - return 7; - } + for (; !splits[0].StartsWith(keepThisRelease, StringComparison.Ordinal); splits.RemoveAt(0)) + if (splits.Count == 1) + { + Console.WriteLine("Error formatting release notes: Can't detemine notes start!"); + return 7; + } - oldNotes = String.Join('\n', splits); + oldNotes = String.Join('\n', splits); - string prefix; - switch (releasingSuite) - { - case 3: - prefix = "The /tg/station server suite"; - break; - default: - prefix = "See https://tgstation.github.io/tgstation-server for installation instructions"; - break; - } + string prefix; + switch (releasingSuite) + { + case 3: + prefix = "The /tg/station server suite"; + break; + default: + prefix = "See https://tgstation.github.io/tgstation-server for installation instructions"; + break; + } - var newNotes = new StringBuilder(prefix); - newNotes.Append(Environment.NewLine); - newNotes.Append(Environment.NewLine); - if (version.Revision == 0) - if (version.Build == 0) - { - newNotes.Append("# [Version "); - newNotes.Append(version.Minor); - } - else - { - newNotes.Append("## [Changelog for "); - newNotes.Append(version.Build); - newNotes.Append(".x"); - } - else - { - newNotes.Append("### [Patch "); - newNotes.Append(version.Revision); - } - newNotes.Append("]("); - var milestone = await milestoneTask.ConfigureAwait(false); - if (milestone == null) - { - Console.WriteLine("Unable to detemine milestone!"); - return 9; - } - newNotes.Append(milestone.HtmlUrl); - newNotes.Append("?closed=1)"); - newNotes.Append(Environment.NewLine); + var newNotes = new StringBuilder(prefix); + newNotes.Append(Environment.NewLine); + newNotes.Append(Environment.NewLine); + if (version.Revision == 0) + if (version.Build == 0) + { + newNotes.Append("# [Version "); + newNotes.Append(version.Minor); + } + else + { + newNotes.Append("## [Changelog for "); + newNotes.Append(version.Build); + newNotes.Append(".x"); + } + else + { + newNotes.Append("### [Patch "); + newNotes.Append(version.Revision); + } + newNotes.Append("]("); + var milestone = await milestoneTask.ConfigureAwait(false); + if (milestone == null) + { + Console.WriteLine("Unable to detemine milestone!"); + return 9; + } + newNotes.Append(milestone.HtmlUrl); + newNotes.Append("?closed=1)"); + newNotes.Append(Environment.NewLine); - await Task.WhenAll(tasks).ConfigureAwait(false); + await Task.WhenAll(tasks).ConfigureAwait(false); - if (releaseDictionary.Count == 0) - { - Console.WriteLine("No release notes for this milestone!"); - return 8; - } + if (releaseDictionary.Count == 0) + { + Console.WriteLine("No release notes for this milestone!"); + return 8; + } - foreach (var I in releaseDictionary) - foreach (var note in I.Value) - { - newNotes.Append(Environment.NewLine); - newNotes.Append("- "); - newNotes.Append(note); - newNotes.Append(" (#"); - newNotes.Append(I.Key); - newNotes.Append(')'); - } + foreach (var I in releaseDictionary) + foreach (var note in I.Value) + { + newNotes.Append(Environment.NewLine); + newNotes.Append("- "); + newNotes.Append(note); + newNotes.Append(" (#"); + newNotes.Append(I.Key); + newNotes.Append(')'); + } - newNotes.Append(Environment.NewLine); - newNotes.Append(Environment.NewLine); - newNotes.Append(oldNotes); + newNotes.Append(Environment.NewLine); + newNotes.Append(Environment.NewLine); + newNotes.Append(oldNotes); - Console.WriteLine("Writing out new release notes..."); - var releaseNotes = newNotes.ToString(); - await File.WriteAllTextAsync("release_notes.md", releaseNotes).ConfigureAwait(false); + Console.WriteLine("Writing out new release notes..."); + var releaseNotes = newNotes.ToString(); + await File.WriteAllTextAsync("release_notes.md", releaseNotes).ConfigureAwait(false); - if (doNotCloseMilestone) - Console.WriteLine("Not closing milestone due to parameter!"); - else - { - Console.WriteLine("Closing milestone..."); - await client.Issue.Milestone.Update(RepoOwner, RepoName, milestone.Number, new MilestoneUpdate - { - State = ItemState.Closed - }).ConfigureAwait(false); - } + if (doNotCloseMilestone) + Console.WriteLine("Not closing milestone due to parameter!"); + else + { + Console.WriteLine("Closing milestone..."); + await client.Issue.Milestone.Update(RepoOwner, RepoName, milestone.Number, new MilestoneUpdate + { + State = ItemState.Closed + }).ConfigureAwait(false); + } - return 0; - } - catch (Exception e) - { - Console.WriteLine(e); - return 4; - } - } - } + return 0; + } + catch (Exception e) + { + Console.WriteLine(e); + return 4; + } + } + } } From 40cbdd48502cda81e95df235f276d020d8381a15 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 26 Nov 2018 15:49:52 -0500 Subject: [PATCH 10/10] Fixup --- .gitignore | 2 +- tgstation-server.sln | 7 +++++++ tools/ReleaseNotes/Program.cs | 12 ++++++------ tools/ReleaseNotes/release_notes.md | 17 ----------------- 4 files changed, 14 insertions(+), 24 deletions(-) delete mode 100644 tools/ReleaseNotes/release_notes.md diff --git a/.gitignore b/.gitignore index 8b0b626b5c..f4f0e4d74f 100644 --- a/.gitignore +++ b/.gitignore @@ -15,4 +15,4 @@ artifacts/ /tests/DMAPI/travistester.int /tests/DMAPI/travistester.dmb /src/Tgstation.Server.Host/appsettings.Development.json -/tools/ReleaseNotes/release_nodes.md +/tools/ReleaseNotes/release_notes.md diff --git a/tgstation-server.sln b/tgstation-server.sln index a7fb21ff65..d3155c0ea4 100644 --- a/tgstation-server.sln +++ b/tgstation-server.sln @@ -114,6 +114,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{E821 EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tgstation.Server.Tests", "tests\Tgstation.Server.Tests\Tgstation.Server.Tests.csproj", "{09056964-1C74-445A-96EC-33F6DFC07916}" EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ReleaseNotes", "tools\ReleaseNotes\ReleaseNotes.csproj", "{5CB51532-55F0-4255-B6E5-69ED5CCD14CD}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -172,6 +174,10 @@ Global {09056964-1C74-445A-96EC-33F6DFC07916}.Debug|Any CPU.Build.0 = Debug|Any CPU {09056964-1C74-445A-96EC-33F6DFC07916}.Release|Any CPU.ActiveCfg = Release|Any CPU {09056964-1C74-445A-96EC-33F6DFC07916}.Release|Any CPU.Build.0 = Release|Any CPU + {5CB51532-55F0-4255-B6E5-69ED5CCD14CD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {5CB51532-55F0-4255-B6E5-69ED5CCD14CD}.Debug|Any CPU.Build.0 = Debug|Any CPU + {5CB51532-55F0-4255-B6E5-69ED5CCD14CD}.Release|Any CPU.ActiveCfg = Release|Any CPU + {5CB51532-55F0-4255-B6E5-69ED5CCD14CD}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -183,6 +189,7 @@ Global {3BB10856-AA01-43D1-AAB0-A013085426D6} = {7E4E7CF6-A48D-410E-8191-C49C6B5AB9CC} {82066812-6C73-4360-943B-B23F2F491261} = {7E4E7CF6-A48D-410E-8191-C49C6B5AB9CC} {057FAC33-CC31-4948-91C6-B0977C335890} = {F7765A4B-021C-454E-ABB1-2AB1B85F91B4} + {5CB51532-55F0-4255-B6E5-69ED5CCD14CD} = {A55C1117-5808-4AB2-BEA6-4D4A3E66A2F2} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {DFD36C95-3E49-41C7-ACDB-86BAF5B18A79} diff --git a/tools/ReleaseNotes/Program.cs b/tools/ReleaseNotes/Program.cs index edd1960dd5..c62af92615 100644 --- a/tools/ReleaseNotes/Program.cs +++ b/tools/ReleaseNotes/Program.cs @@ -75,7 +75,7 @@ namespace ReleaseNotes async Task GetReleaseNotesFromPR(Issue pullRequest) { //need to check it was merged - var fullPr = await client.Repository.PullRequest.Get(RepoOwner, RepoName, pullRequest.Number).ConfigureAwait(false); + var fullPR = await client.Repository.PullRequest.Get(RepoOwner, RepoName, pullRequest.Number).ConfigureAwait(false); async Task GetMilestone() { @@ -151,16 +151,16 @@ namespace ReleaseNotes lock (releaseDictionary) { foreach (var I in notes) - Console.WriteLine("#" + pullRequest.Number + " - " + I + " (@" + user.Login + ")"); - if (releaseDictionary.TryGetValue(pullRequest.Number, out var currentValues)) + Console.WriteLine("#" + fullPR.Number + " - " + I + " (@" + user.Login + ")"); + if (releaseDictionary.TryGetValue(fullPR.Number, out var currentValues)) currentValues.AddRange(notes); else - releaseDictionary.Add(pullRequest.Number, notes); + releaseDictionary.Add(fullPR.Number, notes); } } - var comments = await client.Issue.Comment.GetAllForIssue(RepoOwner, RepoName, pullRequest.Number).ConfigureAwait(false); - await Task.WhenAll(BuildNotesFromComment(pullRequest.Body, pullRequest.User), Task.WhenAll(comments.Select(x => BuildNotesFromComment(x.Body, x.User)))).ConfigureAwait(false); + var comments = await client.Issue.Comment.GetAllForIssue(RepoOwner, RepoName, fullPR.Number).ConfigureAwait(false); + await Task.WhenAll(BuildNotesFromComment(fullPR.Body, fullPR.User), Task.WhenAll(comments.Select(x => BuildNotesFromComment(x.Body, x.User)))).ConfigureAwait(false); } var tasks = new List(); diff --git a/tools/ReleaseNotes/release_notes.md b/tools/ReleaseNotes/release_notes.md deleted file mode 100644 index 25c9366336..0000000000 --- a/tools/ReleaseNotes/release_notes.md +++ /dev/null @@ -1,17 +0,0 @@ -See https://tgstation.github.io/tgstation-server for installation instructions - -## [Changelog for 2.x](https://github.com/tgstation/tgstation-server/milestone/13?closed=1) - -- Added `/datum/tgs_version` to the DMAPI. `/world/TgsVersion()`, `/world/TgsMaximumAPIVersion()`, and `/world/TgsMinimumAPIVersion()` now return this datum (#827) - -## [Changelog for 1.X](https://github.com/tgstation/tgstation-server/milestone/11?closed=1) - -- Added the command line setup wizard. No more need to configure `appsettings.Production.json` manually -- You can now ignore files and folder for symlinking in the `GameStaticFiles` directory using the `.tgsignore` file -- If the repository is configured with valid GitHub synchronization credentials, the user account will now post [test merge comments](https://github.com/tgstation/tgstation/pull/40735#issuecomment-427503427) [when deployments involving them happen](https://github.com/tgstation/tgstation/pull/40736#issuecomment-427503428) -- Releases now contain a `.zip` of the latest DMAPI files -- Installing DirectX on Windows is no longer required for BYOND versions >= 512.1452 -- Updating the server should no longer timeout clients -- Various kinks were ironed out in internal systems - -# [Initial Release](https://github.com/tgstation/tgstation-server/milestone/3?closed=1) \ No newline at end of file