Skip to content

Commit 8f591fd

Browse files
committed
Update ReadMe
1 parent 0d19dd8 commit 8f591fd

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

ReadMe.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,12 @@ Once you start working on the module, you'll create sub-folders in source, and p
114114
3. To force classes to be in a certain order, you can prefix their file names with numbers, like `01-User.ps1`
115115

116116
There are a *lot* of conventions in `Build-Module`, expressed as default values for its parameters. These defaults are documented in the help for Build-Module. You can override any parameter to `Build-Module` by passing it, or by adding keys to the `build.psd1` file with your preferences.
117+
118+
## Changelog
119+
120+
### 3.0.0 - Now with better alias support
121+
122+
Starting with this release, ModuleBuilder will automatically export aliases from `New-Alias` and `Set-Alias` as well as the `[Alias()]` attributes on commands. This is (probably not) a breaking change, but because it can change the aliases exported by existing modules that use ModuleBuilder, I've bumped the major version number as a precaution (if you're reading this, mission accomplished).
123+
124+
Additionally, the `Build-Module` command now _explicitly sorts_ the source files into alphabetical order, to ensure consistent behavior regardless of the native order of the underlying file system. This is technically also a breaking change, but it's unlikely to affect anyone except the people whose builds didn't work on non-Windows systems because of the previous behavior.
125+

Source/ModuleBuilder.psd1

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@
1111

1212
# Release Notes have to be here, so we can update them
1313
ReleaseNotes = '
14-
Second release, including lots of fixed bugs and a few features ...
15-
-
14+
Now with Set/New-Alias support, and sorting of the source files.
1615
'
1716

1817
# Tags applied to this module. These help with module discovery in online galleries.

0 commit comments

Comments
 (0)