GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Switch to GitHub Action for linting markdown by TravisEz13 · Pull Request #19899 · PowerShell/PowerShell

Conversation

@TravisEz13

@TravisEz13 Travis Plunk (TravisEz13) commented Jul 6, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

PR Summary

Switch to GitHub Action for linting markdown

PR Context

It's just easier if the tools aren't directly in our repo.

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
  • This PR is ready to merge and is not 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
    • None
    • OR
    • Experimental feature(s) needed
      • Experimental feature name(s):
  • User-facing changes
    • Not Applicable
    • OR
    • Documentation needed
      • Issue filed:
  • Testing - New and feature
    • 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
  • Tooling
    • 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 opened an issue in the relevant tool repository. This may include:
      • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
        (which runs in a different PS Host).
        • Issue filed:
      • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
        • Issue filed:
      • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
        • Issue filed:
      • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
        • Issue filed:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@TravisEz13
Update markdownLink.yml
d8413eb
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added the Extra Small label Jul 6, 2023
@TravisEz13
Delete test/common/markdown-lint directory
6d2d30d
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added Medium and removed Extra Small labels Jul 6, 2023
@TravisEz13
Delete markdown-link.tests.ps1
7223262
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added Large and removed Medium labels Jul 6, 2023
Travis Plunk (TravisEz13) added 3 commits July 6, 2023 16:15
@TravisEz13
Update markdownLink.yml
a3975a0
@TravisEz13
Update markdownLink.yml
38a4744
@TravisEz13
Break a linting rule
3efb429
TravisEz13
Travis Plunk (TravisEz13) commented Jul 6, 2023
View reviewed changes
Comment thread tools/clearlyDefined/readme.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@TravisEz13
Update tools/clearlyDefined/readme.md
136e93b
@TravisEz13 Travis Plunk (TravisEz13) changed the title Update markdownLink.yml Switch to GitHub Action for linting markdown Jul 6, 2023
@TravisEz13
Travis Plunk (TravisEz13) marked this pull request as ready for review July 6, 2023 23:32
@TravisEz13
Travis Plunk (TravisEz13) requested review from Aditya Patwardhan (adityapatwardhan), Andrew (anmenaga) and Dongbo Wang (daxian-dbw) as code owners July 6, 2023 23:32
SteveL-MSFT
Steve Lee (SteveL-MSFT) approved these changes Jul 6, 2023
View reviewed changes

@SteveL-MSFT Steve Lee (SteveL-MSFT) left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
JamesWTruher
James Truher (JamesWTruher) reviewed Jul 6, 2023
View reviewed changes
Comment thread .github/workflows/markdownLink.yml Resolved

Uh oh!

There was an error while loading. Please reload this page.

JamesWTruher
James Truher (JamesWTruher) approved these changes Jul 6, 2023
View reviewed changes

@JamesWTruher James Truher (JamesWTruher) left a comment

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

just a typo to correct

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@TravisEz13 @JamesWTruher
Update .github/workflows/markdownLink.yml
0af1807
Co-authored-by: James Truher [MSFT] <[email protected]>
@TravisEz13
Travis Plunk (TravisEz13) merged commit aa31732 into master Jul 7, 2023
@TravisEz13
Travis Plunk (TravisEz13) deleted the Remove-direct-use-of-markdownlint branch July 7, 2023 17:15
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented Jul 7, 2023

Copy link
Copy Markdown

This PR has 240 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Large
Size       : +16 -224
Percentile : 64%

Total files changed: 7

Change summary by file extension:
.yml : +16 -1
.ps1 : +0 -157
.gitignore : +0 -1
.js : +0 -37
.json : +0 -28
.lock : +0 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@SeeminglyScience Patrick Meinecke (SeeminglyScience) added the CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log label Aug 17, 2023
@TravisEz13 Travis Plunk (TravisEz13) added Backport-7.2.x-Consider labels Sep 19, 2023
Travis Plunk (TravisEz13) added a commit to TravisEz13/PowerShell that referenced this pull request Sep 19, 2023
@TravisEz13
Switch to GitHub Action for linting markdown (PowerShell#19899)
ab61811
@TravisEz13 Travis Plunk (TravisEz13) mentioned this pull request Sep 19, 2023
[release/v7.3.8]Switch to GitHub Action for linting markdown #20308
Merged
Travis Plunk (TravisEz13) added a commit to TravisEz13/PowerShell that referenced this pull request Sep 19, 2023
@TravisEz13
Switch to GitHub Action for linting markdown (PowerShell#19899)
5bdcca2
@TravisEz13 Travis Plunk (TravisEz13) mentioned this pull request Sep 19, 2023
[release/v7.2.15]Switch to GitHub Action for linting markdown #20309
Merged
@TravisEz13 Travis Plunk (TravisEz13) added Backport-7.2.x-Approved and removed Backport-7.2.x-Consider labels Sep 20, 2023
Dongbo Wang (daxian-dbw) pushed a commit that referenced this pull request Sep 20, 2023
@TravisEz13
Switch to GitHub Action for linting markdown (#19899) (#20309)
22a813e
@daxian-dbw Dongbo Wang (daxian-dbw) added Backport-7.2.x-Done Backport-7.3.x-Done and removed Backport-7.2.x-Approved labels Sep 20, 2023
@TravisEz13 Travis Plunk (TravisEz13) mentioned this pull request Apr 16, 2024
WIP: add more detail to suspicious scriptblock logging #21475
Closed
@TravisEz13 Travis Plunk (TravisEz13) mentioned this pull request Jul 9, 2024
Add script to update SDK for release branches #24034
Merged
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@TravisEz13
Switch to GitHub Action for linting markdown (PowerShell#19899)
a7ba7b5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SteveL-MSFT Steve Lee (SteveL-MSFT) SteveL-MSFT approved these changes
@daxian-dbw Dongbo Wang (daxian-dbw) Awaiting requested review from daxian-dbw
@adityapatwardhan Aditya Patwardhan (adityapatwardhan) Awaiting requested review from adityapatwardhan
@anmenaga Andrew (anmenaga) Awaiting requested review from anmenaga
+1 more reviewer
@JamesWTruher James Truher (JamesWTruher) JamesWTruher approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

Backport-7.2.x-Done Backport-7.3.x-Done CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log Large

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@TravisEz13 @JamesWTruher @SteveL-MSFT @daxian-dbw @SeeminglyScience
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.