View Code? Open in Web Editor
NEW
PowerShell module for WattTime API free functions
License: GNU General Public License v3.0
pswatttime's People
Contributors
Watchers
pswatttime's Issues
๐ Documentation Issue Report
Describe the bug
The markdown docs for the individual functions in docs/
does not adhere to any common markdown sub-standard
To Reproduce
Clone the repo
Generate markdown docs for the module using New-MarkdownHelp
Check the output files, headers are missing a blank line below, code blocks are missing a language identifier
Media prove
See current main
branch as of 12-03-2023 15:22
Describe the solution you'd like
Check what is within the possibilities to get better markdown given the current state of PlatyPS
Check if there are better alternatives to PlatyPS if needed
Additional context
๐ Bug Report
Describe the bug
It turns out the percentage for the readings is returned as a string
. Therefore the sorting may return 24
as a better option than 3
Expected behaviour
3
percent should be better than 24
percent.
๐ Feature Request
Is your feature request related to a problem? Please describe.
Pester test results are not optimized for GitHub readability
Describe the solution you'd like
Better readability of logging
Nice to have: some kind of nice markdown output with code coverage etc for the run or as PR comment
Describe alternatives you've considered
Spending more time reading logging, not desirable
Additional context
๐ Bug Report
Describe the bug
The test for the GitHub action in the qa.yml
pipeline is hardcoded to use main branch
Using main branch means the action is never truly tested before being merged to main
Is this a regression?
This never worked
To Reproduce
See this line for the hardcoded ref to main.
Expected behaviour
I expect a test to test the current commit
I expect the github action to be tested before being merged to main
Media prove
See this line for the hardcoded ref to main.
Your environment
OS: Ubuntu-22.04
PowerShell version:
Azure PowerShell version:
Additional context
๐ Feature Request
Add percentage output to the GitHub action
Is your feature request related to a problem? Please describe.
I would like to be able to make the actual best emissions percentage a deciding factor in my GitHub workflow
Describe the solution you'd like
An extra output added to the action for the percentage value which is already available in PSWattTime
Describe alternatives you've considered
Additional context
๐ Feature Request
Is your feature request related to a problem? Please describe.
Some nice docs exist within the repo, a proper GitHub Wiki is however missing.
A Wiki would add to the useability of PSWatttTime
Describe the solution you'd like
Extension of the current release publishing workflow to generate and publish docs for the released version.
Use of GitHub Wiki functionality
Describe alternatives you've considered
Maintaining a GitHub wiki manually
Additional context
๐ Documentation Issue Report
Describe the bug
This project does not yet have a CONTRIBUTING.md
file
To Reproduce
Check the GitHub repository
Describe the solution you'd like
A rudimentary guide explaining what is expected of people who want to contribute to the project.
Additional context
๐ Documentation Issue Report
Describe the bug
The SECURITY.md
file is lacking a statement on some released version numbers
To Reproduce
Open repository site on GitHUb
Navigate to About -> Security Policy
Describe the solution you'd like
A specification that either direct or implied covers the support level of all versions that are released on GitHub or PowerShell Gallery
๐ Feature Request
Is your feature request related to a problem? Please describe.
When doing resource deployments making use of Azure's paired regions, I want to know which combinations of paired regions have the best carbon emissions.
Describe the solution you'd like
When I supply a list of regions, I would like a switch parameter to indicate I want the function to also lookup the paired region for each supplied region and combine those emissions to find the best pair
A nice to have would be to supply some factor number in the equation with the main and paired region. Often the paired region will contain less resources or have less active use than the main region, so counting it's emissions equally might not be the best solution in all cases.
Describe alternatives you've considered
Writing the solution for this issue outside the module. The use case seems pretty common, so worthwhile adopting it in PSWattTime itself.
Additional context
This should use the Paired Region info in the output of the Get-AzLocation
command of the Az.Resources
Module already used in the module