Changelog tools #1961

rjmholt · 2019-05-13T20:41:05Z

Adds changelog generation tools to the repo.

The module has some slightly opinionated things about generating a changelog for any repo, and the script generates changelogs for PowerShellEditorServices and vscode-PowerShell and opens PRs for both of them.

All configurable with labelling etc.

rkeithhill · 2019-05-14T02:30:38Z

tools/GitHubTools.psm1

+    }
+}
+
+filter GetHumanishRepositoryDetails


git seems to like using the ish suffix to refer to softened parameter "types", like commitish and humanish

I'm familiar with "commitish" but not "humanish". Thx.

Aggravatingly they use the terms in passing and you have to sift through StackOverflow to decode them

rkeithhill

Cool stuff here!

tools/ChangelogTools.psm1

TylerLeonhardt · 2019-05-20T14:49:28Z

Oh?

rjmholt · 2019-05-20T15:50:54Z

Ah that's because I accidentally deleted the branch!

rjmholt · 2019-05-20T16:07:46Z

Ok here's the kinds of PR this opens:

A few notes:

This adds a little emoji based on the issue label, if there is one
The link is always to the PR, but if it closes an issue the issue is used as the name. When vscode-powershell issues are closed in PSES, it says [vscode-PowerShell #XXXX]
If there's no PR for a commit, there's no [...] at the start
This depends on the GitHub commit message format where it adds (#XXXX) to the end of commit messages
We can easily add more tags in various places:
- PR labels like PowerShell's CL-Breaking tags
- Issue labels, like the existing Issue-Bug, Issue-Enhancement
- In commits with [tag] -- currently [Ignore] is registered

The changelog script also separates the changelog into sections if any PRs close categorised issues (e.g. Area-PSReadLine). Again we can easily add to this with PR labels too.

TylerLeonhardt · 2019-05-21T21:18:35Z

tools/changelog/updateChangelog.ps1

+    Get-ChangeInfoFromCommit -GitHubToken $GitHubToken |
+    Skip-IgnoredChange @ignore |
+    New-ChangelogEntry @clEntryParams |
+    New-ChangelogSection @clSectionParams -Preamble "#### [$psesRepoName](https://github.com/$Organization/$psesRepoName)"


PSES does not have this Preamble

corbob · 2019-05-23T00:00:49Z

tools/ChangelogTools.psm1

+    }
+}
+
+filter New-ChangelogEntry


I don't know how important making Codacy green is here, but could add something like: [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "", Justification="We're not actually changing system state.")] to suppress it complaining about failing the PSSA rule...

Ironically there are much more dangerous methods in the GitHubTools.psm1 module that it misses. PSScriptAnalyzer has some weird bits in it frankly -- I'd love to make it more logical.

TylerLeonhardt · 2019-06-25T19:54:47Z

tools/GitHubTools.psm1

+
+    if ($CloneBranch)
+    {
+        Write-Verbose "Cloned branch: $CloneBranch"


shouldn't this be after the exec?

TylerLeonhardt · 2019-06-25T19:58:08Z

tools/changelog/updateChangelog.ps1

@@ -6,22 +6,55 @@
 using module ..\GitHubTools.psm1
 using module ..\ChangelogTools.psm1

+<#
+.EXAMPLE
+.\updateChangelog.ps1 -GitHubToken $ghTok -PSExtensionSinceRef v2.0.0-preview.3 -PsesSinceRef v2.0.0-preview.3 -PSExtensionVersion 2019.5.0 -PsesVersion 1.12.2 -PSExtensionUntilRef legacy/1.x -PsesUntilRef legacy/1.x -Verbose


I'm confused by this example. You have a mix of preview and legacy?

TylerLeonhardt · 2019-06-25T20:00:14Z

tools/changelog/updateChangelog.ps1

+    RepositoryPath = $PsesRepositoryPath
+    Verbose = $VerbosePreference
+}
+
 $clEntryParams = @{
    EntryCategories = $categories
    DefaultCategory = $defaultCategory
    TagLabels = @{


TylerLeonhardt · 2019-06-25T20:03:03Z

tools/changelog/updateChangelog.ps1

-$psesChangelogPostamble = ($psesChangelogSection -split "`n")
-$psesChangelogPostamble = $psesChangelogPostamble[2..$psesChangelogPostamble.Length]
+$psesChangelogPostamble = $psesChangelogSection -split "`n"
+$psesChangelogPostamble = @("#### [$psesRepoName](https://github.com/$Organization/$psesRepoName)") + $psesChangelogPostamble[2..($psesChangelogPostamble.Length-3)]


It'd be nice if you added a small comment about these numbers ( 2 and 3)

TylerLeonhardt

LGTM just a couple questions. Maybe do one test of this from a newly cloned PowerShell/vscode-powershell and PowerShell/PowerShellEditorServices

Co-Authored-By: rjmholt <[email protected]>

rjmholt requested review from TylerLeonhardt, rkeithhill and SydneyhSmith May 13, 2019 20:41

rkeithhill reviewed May 14, 2019

View reviewed changes

rkeithhill approved these changes May 14, 2019

View reviewed changes

TylerLeonhardt reviewed May 17, 2019

View reviewed changes

tools/ChangelogTools.psm1 Outdated Show resolved Hide resolved

rjmholt closed this May 20, 2019

rjmholt deleted the changelog-tools branch May 20, 2019 05:49

rjmholt restored the changelog-tools branch May 20, 2019 05:49

rjmholt reopened this May 20, 2019

rjmholt force-pushed the changelog-tools branch from a1e5da1 to 16670e4 Compare May 20, 2019 16:17

rjmholt changed the title ~~WIP: Changelog tools~~ Changelog tools May 20, 2019

TylerLeonhardt reviewed May 21, 2019

View reviewed changes

corbob reviewed May 23, 2019

View reviewed changes

TylerLeonhardt reviewed Jun 25, 2019

View reviewed changes

tools/GitHubTools.psm1

if ($CloneBranch)

{

Write-Verbose "Cloned branch: $CloneBranch"

Copy link

Member

TylerLeonhardt Jun 25, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't this be after the exec?

TylerLeonhardt reviewed Jun 25, 2019

View reviewed changes

TylerLeonhardt approved these changes Jun 25, 2019

View reviewed changes

rjmholt and others added 8 commits September 16, 2019 09:39

Add AzureDataStudio update script

bec93f7

Copyright headers

83b39a8

Fix ads updater, add vsix version updater script

88794a6

Improve existing scripts, add PSES update script

947fa3a

Fix param name issue

ac7c8e6

Update tools/repoUpdateScripts/updatePsesVersions.ps1

797cb1a

Co-Authored-By: rjmholt <[email protected]>

Simplify default parameters, move dir

d690cfe

Give proper names to functions

37f9978

rjmholt and others added 12 commits September 16, 2019 09:43

Add thanks

a8222d7

WIP

231642f

Progress

fb00c39

Add skeleton

49fca7e

Current

382a47e

Update to open both changelogs

2de74e1

Fix label bug

29756e0

Minor fixes -- but still there

34c3658

Fix bad project name assignment

8673787

Fix documentation loss

f7f03cb

Fix bugs

caa3bb4

Add verbosity, fix whitespace bugs

6a676e4

rjmholt force-pushed the changelog-tools branch from 0185713 to f5e6c8b Compare September 16, 2019 16:55

Robert Holt and others added 14 commits September 16, 2019 09:55

Fix upstream issues

c9cb4e5

Add subject polishing, fix date format

29847a4

Add auto release name

0631794

Add extension name to PR title

3ac02f8

Fix release name bug

eba4cb0

Update ReleaseName usage

a5a2f35

Fix verbose parameter

c5ff021

Fix verbose

5f92667

Fix branch usage

19d9509

Updates

62c70cf

Fix silliness

f317722

Add changelog emoji

3672256

Update emoji

f5e6c8b

Address @TylerLeonhardt's feedback

ac31eb6

TylerLeonhardt approved these changes Sep 16, 2019

View reviewed changes

TylerLeonhardt merged commit 02236bd into PowerShell:master Sep 17, 2019

rjmholt deleted the changelog-tools branch December 11, 2019 21:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changelog tools #1961

Changelog tools #1961

rjmholt commented May 13, 2019 •

edited

Loading

rkeithhill May 14, 2019

rjmholt May 14, 2019 •

edited

Loading

rkeithhill May 14, 2019

rjmholt May 14, 2019

rkeithhill left a comment

TylerLeonhardt commented May 20, 2019

rjmholt commented May 20, 2019

rjmholt commented May 20, 2019 •

edited

Loading

TylerLeonhardt May 21, 2019

corbob May 23, 2019

rjmholt May 23, 2019

TylerLeonhardt Jun 25, 2019

TylerLeonhardt Jun 25, 2019

TylerLeonhardt Jun 25, 2019

TylerLeonhardt Jun 25, 2019

TylerLeonhardt left a comment

Changelog tools #1961

Changelog tools #1961

Conversation

rjmholt commented May 13, 2019 • edited Loading

Choose a reason for hiding this comment

rjmholt May 14, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rkeithhill left a comment

Choose a reason for hiding this comment

TylerLeonhardt commented May 20, 2019

rjmholt commented May 20, 2019

rjmholt commented May 20, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TylerLeonhardt left a comment

Choose a reason for hiding this comment

rjmholt commented May 13, 2019 •

edited

Loading

rjmholt May 14, 2019 •

edited

Loading

rjmholt commented May 20, 2019 •

edited

Loading