Skip to content

Add links to diffs on Github in changelog #11652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 29, 2020

Conversation

xtqqczze
Copy link
Contributor

@xtqqczze xtqqczze commented Jan 21, 2020

PR Summary

Provide links to the Github compare view for each release.

PR Context

This change provides for an easy method to access Github's compare features.

Commit 8a1d894 from #11644 is included in this branch to ensure an straightforward merge.

PR Checklist

@xtqqczze
Copy link
Contributor Author

We should investigate why Github issues are not being hyperlinked in the changelog.

@xtqqczze
Copy link
Contributor Author

Markdown-link test failure is unrelated.

@xtqqczze xtqqczze force-pushed the feature-changelog-github-compare branch from 820abb5 to 1210042 Compare January 22, 2020 01:23
@xtqqczze
Copy link
Contributor Author

PowerShell-CI-static-analysis failure is unrelated, #11653 will fix.

@iSazonov
Copy link
Collaborator

iSazonov commented Jan 22, 2020

Looks great!

Maybe add diffs based on previous major and minor version like 7.0 - 6.0 and 6.2.0 - 6.0.0 ?

@daxian-dbw
Copy link
Member

@PoshChan Please retry static

@PoshChan
Copy link
Collaborator

@daxian-dbw, successfully started retry of PowerShell-CI-static-analysis

Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

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

Looks good to me, but I would like to get sign-off from other maintainers too.

@daxian-dbw daxian-dbw requested a review from iSazonov January 22, 2020 16:49
Copy link
Collaborator

@iSazonov iSazonov left a comment

Choose a reason for hiding this comment

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

LGTM.

As I mentioned above perhaps we could add diffs based on 6.0.0 (later on 7.0.0) for major and minor versions so that users can get a list of the commits from 6.0 to 6.1, from 6.0 to 6.2, from 6.0 to 7.0 and so on.
We can add this in follow PR.

@iSazonov
Copy link
Collaborator

@xtqqczze Please rebase to pass CI static.

@daxian-dbw
Copy link
Member

The failure in static build is new and is related to the changes in this PR.

@iSazonov
Copy link
Collaborator

Perhaps rebase helps.

Change to international date format to match date format in `CHANGELOG/6.1.md` etc.
@xtqqczze xtqqczze force-pushed the feature-changelog-github-compare branch from 1210042 to 5f2a89b Compare January 23, 2020 04:07
@xtqqczze
Copy link
Contributor Author

@daxian-dbw rebase passed checks

@iSazonov
Copy link
Collaborator

@TravisEz13 @adityapatwardhan Have you any objections or we can merge?

@TravisEz13 TravisEz13 added the CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log label Jan 28, 2020
@TravisEz13 TravisEz13 added this to the 7.1.0-preview.1 milestone Jan 28, 2020
@iSazonov iSazonov merged commit 148124e into PowerShell:master Jan 29, 2020
@TravisEz13
Copy link
Member

TravisEz13 commented Jan 30, 2020

@xtqqczze It would be good if you updated the script to generate the change log with these changes:
https://github.com/PowerShell/PowerShell/blob/master/tools/releaseTools.psm1
The file already has new entries that doesn't match your changes.

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@xtqqczze
Copy link
Contributor Author

@TravisEz13 Thanks for your suggestion. I will create a follow-up PR to exclude regressions.

xtqqczze added a commit to xtqqczze/PowerShell-PowerShell that referenced this pull request Jan 30, 2020
@xtqqczze xtqqczze mentioned this pull request Jan 30, 2020
14 tasks
@xtqqczze
Copy link
Contributor Author

xtqqczze commented Jan 30, 2020

@xtqqczze It would be good if you updated the script to generate the change log with these changes:
https://github.com/PowerShell/PowerShell/blob/master/tools/releaseTools.psm1

@TravisEz13 Please see #11736

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@xtqqczze
Copy link
Contributor Author

xtqqczze commented Feb 1, 2020

As I mentioned above perhaps we could add diffs based on 6.0.0 (later on 7.0.0) for major and minor versions so that users can get a list of the commits from 6.0 to 6.1, from 6.0 to 6.2, from 6.0 to 7.0 and so on.
We can add this in follow PR.

@iSazonov I'm not sure we would present these additional diffs, so I'll leave this up-for grabs.

ghost pushed a commit that referenced this pull request Feb 5, 2020
# PR Summary

* Fix regression from #11652
* Fix [MD022](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines) / [MD032](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines) rule violations
* Modify `Get-ChangeLog` to generate the changelog according to the format from #11652.

## PR Context

Follow-up to #11652

## PR Checklist

- [x] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
    - Use the present tense and imperative mood when describing your changes
- [x] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
- [x] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
- [x] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress).
    - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready.
- **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)**
    - [x] None
    - **OR**
    - [ ] [Experimental feature(s) needed](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/reference/6/Microsoft.PowerShell.Core/About/about_Experimental_Features.md)
        - [ ] Experimental feature name(s): <!-- Experimental feature name(s) here -->
- **User-facing changes**
    - [x] Not Applicable
    - **OR**
    - [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
        - [ ] Issue filed: <!-- Number/link of that issue here -->
- **Testing - New and feature**
    - [x] N/A or can only be tested interactively
    - **OR**
    - [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting)
- **Tooling**
    - [x] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
    - **OR**
    - [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
        - Impact on [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices) which is used in the [PowerShell extension](https://github.com/PowerShell/vscode-powershell) for VSCode (which runs in a different PS Host).
        - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
        - Impact on [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) (which provides linting & formatting in the editor extensions).
        - Impact on [EditorSyntax](https://github.com/PowerShell/EditorSyntax) (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
@ghost
Copy link

ghost commented Feb 21, 2020

🎉v7.0.0-rc.3 has been released which incorporates this pull request.:tada:

Handy links:

ghost pushed a commit that referenced this pull request May 19, 2020
# PR Summary

Add link to Github compare in `CHANGELOG\preview.md`

## PR Context

follow-up #11652

## PR Checklist

- [x] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
    - Use the present tense and imperative mood when describing your changes
- [x] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
- [x] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
- [x] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress).
    - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready.
- **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)**
    - [x] None
    - **OR**
    - [ ] [Experimental feature(s) needed](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/reference/6/Microsoft.PowerShell.Core/About/about_Experimental_Features.md)
        - [ ] Experimental feature name(s): <!-- Experimental feature name(s) here -->
- **User-facing changes**
    - [x] Not Applicable
    - **OR**
    - [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
        - [ ] Issue filed: <!-- Number/link of that issue here -->
- **Testing - New and feature**
    - [x] N/A or can only be tested interactively
    - **OR**
    - [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting)
- **Tooling**
    - [x] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
    - **OR**
    - [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
        - Impact on [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices) which is used in the [PowerShell extension](https://github.com/PowerShell/vscode-powershell) for VSCode (which runs in a different PS Host).
        - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
        - Impact on [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) (which provides linting & formatting in the editor extensions).
        - Impact on [EditorSyntax](https://github.com/PowerShell/EditorSyntax) (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
silijon pushed a commit to SkyKick/PowerShell that referenced this pull request Jul 2, 2020
* Use consistent date format in markdown files

Change to international date format to match date format in `CHANGELOG/6.1.md` etc.

* Add links to compare views on Github
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants