Skip to content

Commit

Permalink
Prepare for version 0.1.4
Browse files Browse the repository at this point in the history
  • Loading branch information
Zhaopudark committed May 10, 2024
1 parent 6a8cd17 commit 41caf58
Show file tree
Hide file tree
Showing 12 changed files with 15 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/workflows/APIs-Tests-on-Linux.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- dev

jobs:
api-tests-on-linux:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/APIs-Tests-on-MacOS.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- dev

jobs:
api-tests-on-macos:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/APIs-Tests-on-Windows.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- dev

jobs:
api-tests-on-windows:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/Components-Tests-on-Linux.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- dev

jobs:
component-tests-on-linux:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/Components-Tests-on-MacOS.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- dev

jobs:
component-tests-on-macos:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/Components-Tests-on-Windows.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- dev

jobs:
component-tests-on-windows:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/Intsallation-Tests-on-Linux.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- dev

jobs:
installation-tests-on-linux:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/Intsallation-Tests-on-MacOS.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- dev

jobs:
installation-tests-on-macos:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/Intsallation-Tests-on-Windows.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- dev

jobs:
installation-tests-on-windows:
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Here are some formative rules for this module's development:
- **Coding:**
- **Variable Naming**: `snake_case` is used to indicate private variables while `PascalCase` is used for non-private variables. So, in code style consistency, please consider the above rule.

- **Comments** : This module refers to many cmdlets in [Microsoft.PowerShell.Management](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/?view=powershell-7.3), such as [`Get-Item`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/get-item?view=powershell-7.3), [`Copy-Item`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/copy-item?view=powershell-7.3) and [`New-Item`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/new-item?view=powershell-7.3). Then, we decided to use a similar comment style as theirs. The following are some specific rules::
- **Comments**: This module refers to many cmdlets in [Microsoft.PowerShell.Management](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/?view=powershell-7.3), such as [`Get-Item`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/get-item?view=powershell-7.3), [`Copy-Item`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/copy-item?view=powershell-7.3) and [`New-Item`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/new-item?view=powershell-7.3). Then, we decided to use a similar comment style as theirs. The following are some specific rules::
- `.SYNOPSIS` and `.DESCRIPTION` are both used to describe the function's usage and details.
- `.DESCRIPTION` is mandatory while `.SYNOPSIS` is optional.
- `.SYNOPSIS` is a brief description of key points, but `.DESCRIPTION` is a detailed description with rationales and ideas.
Expand All @@ -22,6 +22,6 @@ Here are some formative rules for this module's development:
- `.LINK` is used to post crucial links in the format `[aaaa](bbb)` without any other words.
- Given that, at the moment, widescreen monitors are not uncommon, don't actively make length constraints on comments, and don't manually split lines in the middle of sentences. The task of constraining the length of comments can be left to editors and automation tools and not reflected in the source code.
- **Internal Behaviors:**
- **Logging:**: The principle is that when making logs, the logs will be written into files anyway. If a log needs to be displayed in the console, it will be done as a `Verbose` message. The private function `Write-FileLog` should only be used in the private function `Write-Log`, and the latter is the only logging function in all components. Also, the latter is not an API function for normal users.
- **Logging**: The principle is that when making logs, the logs will be written into files anyway. If a log needs to be displayed in the console, it will be done as a `Verbose` message. The private function `Write-FileLog` should only be used in the private function `Write-Log`, and the latter is the only logging function in all components. Also, the latter is not an API function for normal users.
- **Objects to Operate:**
- **Hardlinks:**: Although hard links can sometimes be considered normal files, in this module, it is recommended to restrict any `copy-` or `move-` operations on hard links to avoid potential problems.
- **Hardlinks**: Although hard links can sometimes be considered normal files, in this module, it is recommended to restrict any `copy-` or `move-` operations on hard links to avoid potential problems.
2 changes: 1 addition & 1 deletion Module/PSComputerManagementZp.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ $ModuleInfo = @{
$ModuleSettings = @{
RootModule = "$($ModuleInfo.ModuleName).psm1"
CompatiblePSEditions = @('Desktop', 'Core')
ModuleVersion = '0.1.3'
ModuleVersion = '0.1.4'
Prerelease = ''
Author = 'Pu Zhao'
Description = 'A PowerShell module that derives from personal scenarios, can help users configure the Windows PCs easily to realize many useful operations, involving authorization, env, links, proxy, etc. Some features are also available on WSL2, Linux, and MacOS. See [PSComputerManagementZp](https://github.com/Zhaopudark/PSComputerManagementZp) for more details.'
Expand Down
2 changes: 2 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# PSComputerManagementZp 0.1.x
## Release 0.1.4
On working...
## Release 0.1.3
- Add `Register-AndBackupEnvItemForConda` and `Unregister-WithBackupEnvItemForConda` in `Assister.ThirdParty.ps1` to help users to register and unregister the environment variables for `Conda` with backup. See [Conda | Saving environment variables](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#saving-environment-variables) and [the source code](https://github.com/Zhaopudark/PSComputerManagementZp/blob/main/Module/Public/Assister.ThirdParty.ps1) for more details.
## Release 0.1.2
Expand Down

0 comments on commit 41caf58

Please sign in to comment.