microsoft / winget-dsc

MIT License
23 stars 14 forks source link

Initial setup on QA tests #124

Open Gijsreyn opened 2 weeks ago

Gijsreyn commented 2 weeks ago

Addresses issue #123

Microsoft Reviewers: Open in CodeFlow
github-actions[bot] commented 2 weeks ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

pssa

These words are not needed and should be removed Toolpackage

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands ... in a clone of the [git@github.com:Gijsreyn/winget-dsc.git](https://github.com/Gijsreyn/winget-dsc.git) repository on the `module-quality-tests` branch ([:information_source: how do I use this?]( https://docs.check-spelling.dev/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.24/apply.pl' | perl - 'https://github.com/microsoft/winget-dsc/actions/runs/11722344544/attempts/1' ```
Pattern suggestions :scissors: (3) You could add these patterns to `.github/actions/spelling/patterns.txt`: ``` # Automatically suggested patterns # hit-count: 19 file-count: 6 # Compiler flags (?:^|[\t ,"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) # hit-count: 3 file-count: 1 # githubusercontent /[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]* # hit-count: 2 file-count: 1 # GitHub SHAs (markdown) (?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|) ```
Notices (1) #### See the [:open_file_folder: files](https://github.com/microsoft/winget-dsc/pull/124/files/) view, the [:scroll:action log](https://github.com/microsoft/winget-dsc/actions/runs/11722344544/job/32651680697#step:4:1), or [:memo: job summary](https://github.com/microsoft/winget-dsc/actions/runs/11722344544/attempts/1#summary-32651680697) for details. [:information_source: Notices](https://docs.check-spelling.dev/Event-descriptions) | Count -|- [:information_source: candidate-pattern](https://docs.check-spelling.dev/Event-descriptions#candidate-pattern) | 5 See [:information_source: Event descriptions](https://docs.check-spelling.dev/Event-descriptions) for more information.
If the flagged items are :exploding_head: false positives If items relate to a ... * binary file (or some other file you wouldn't want to check at all). Please add a file path to the `excludes.txt` file matching the containing file. File paths are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( ../tree/HEAD/README.md) (on whichever branch you're using). * well-formed pattern. If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, try adding it to the `patterns.txt` file. Patterns are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. Note that patterns can't match multiline strings.
github-actions[bot] commented 2 weeks ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

pssa

These words are not needed and should be removed Toolpackage

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands ... in a clone of the [git@github.com:Gijsreyn/winget-dsc.git](https://github.com/Gijsreyn/winget-dsc.git) repository on the `module-quality-tests` branch ([:information_source: how do I use this?]( https://docs.check-spelling.dev/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.24/apply.pl' | perl - 'https://github.com/microsoft/winget-dsc/actions/runs/11722863510/attempts/1' ```
Pattern suggestions :scissors: (3) You could add these patterns to `.github/actions/spelling/patterns.txt`: ``` # Automatically suggested patterns # hit-count: 19 file-count: 6 # Compiler flags (?:^|[\t ,"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) # hit-count: 3 file-count: 1 # githubusercontent /[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]* # hit-count: 2 file-count: 1 # GitHub SHAs (markdown) (?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|) ```
Notices (1) #### See the [:open_file_folder: files](https://github.com/microsoft/winget-dsc/pull/124/files/) view, the [:scroll:action log](https://github.com/microsoft/winget-dsc/actions/runs/11722863510/job/32653305278#step:4:1), or [:memo: job summary](https://github.com/microsoft/winget-dsc/actions/runs/11722863510/attempts/1#summary-32653305278) for details. [:information_source: Notices](https://docs.check-spelling.dev/Event-descriptions) | Count -|- [:information_source: candidate-pattern](https://docs.check-spelling.dev/Event-descriptions#candidate-pattern) | 5 See [:information_source: Event descriptions](https://docs.check-spelling.dev/Event-descriptions) for more information.
If the flagged items are :exploding_head: false positives If items relate to a ... * binary file (or some other file you wouldn't want to check at all). Please add a file path to the `excludes.txt` file matching the containing file. File paths are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( ../tree/HEAD/README.md) (on whichever branch you're using). * well-formed pattern. If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, try adding it to the `patterns.txt` file. Patterns are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. Note that patterns can't match multiline strings.
Gijsreyn commented 2 weeks ago

Hey @denelon, @ryfu-msft and @Trenly,

I thought of giving this one a shot to improve the quality in this repository. This might annoy people in first, but in the end it is for the betterment for everyone. I know Ryan you have been working on #56, but I have also included it in here.

The pull request is not finished yet, but when you have some time, you mind taking a glimpse at this one and share your thoughts? Thanks in advance.

github-actions[bot] commented 1 week ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

pssa

These words are not needed and should be removed cspell Toolpackage Workaround

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands ... in a clone of the [git@github.com:Gijsreyn/winget-dsc.git](https://github.com/Gijsreyn/winget-dsc.git) repository on the `module-quality-tests` branch ([:information_source: how do I use this?]( https://docs.check-spelling.dev/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.24/apply.pl' | perl - 'https://github.com/microsoft/winget-dsc/actions/runs/11830584675/attempts/1' ```
If the flagged items are :exploding_head: false positives If items relate to a ... * binary file (or some other file you wouldn't want to check at all). Please add a file path to the `excludes.txt` file matching the containing file. File paths are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( ../tree/HEAD/README.md) (on whichever branch you're using). * well-formed pattern. If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, try adding it to the `patterns.txt` file. Patterns are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. Note that patterns can't match multiline strings.