Skip to content

Commit 3681291

Browse files
committed
v1.5.0 Release Candidate 1
## [1.5.0-RC1] - Unreleased ### Added - Add multilingual support for AsBuiltReport Core module - `Initialize-LocalizedData` function to handle localization for both Core and Report modules - `Resolve-Culture` function with comprehensive culture fallback chains for 135+ culture variants - Localized user prompts and messages in `New-AsBuiltConfig` function. Support for all main languages. - `ReportLanguage` parameter added to `New-AsBuiltReport` function with dynamic validation based on available languages in individual report modules - Support for setting default language in report JSON configuration files using the `Report.Language` property - Add PowerShell module dependency checking for report modules with `Get-RequiredModule` function - Add `Draw-AsciiBanner` function to improve user interface in `New-AsBuiltConfig` - Add `Write-ReportModuleInfo` function to provide information on report modules - Add `SECURITY.md` and `CODE_OF_CODUCT.md` documentation - Add `Stale.yml` GitHub workflow to manage GitHub issues - Add `FUNDING.yml` to provide sponsorship links - Improve error handling with comprehensive try-catch blocks and meaningful error messages ### Changed - Core module functions (`New-AsBuiltConfig`, `New-AsBuiltReport`, `New-AsBuiltReportConfig`) now default to user's OS language instead of hardcoded English - Report modules default to 'en-US' when no other language is supported - Update parameter validation to use ValidateScript blocks for dynamic language detection - Update `AsBuiltReport.Core.Style.ps1` script to support language translation - Enhanced error messages to include specific language and module information - Improved progress messaging during report generation - Update all y/n prompts in `New-AsBuiltConfig` to show defaults and handle empty input - Renamed `MFA` parameter to `UseInteractiveAuth` (`MFA` alias retained for backwards compatibility) - Update `README.md` and `CONTRIBUTING.md` documentation - Update `LICENSE` # Removed - Remove sample style scripts
1 parent 2d38585 commit 3681291

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1066
-414
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@
3131
- [ ] My code follows the code style of this project.
3232
- [ ] My change requires a change to the documentation.
3333
- [ ] I have updated the documentation accordingly.
34-
- [ ] I have read the [**CONTRIBUTING**](https://www.asbuiltreport.com/about/contributing/) page.
34+
- [ ] I have read the [**CONTRIBUTING**](/CONTRIBUTING.md) page.

.github/workflows/Stale.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 'Close stale issues and PRs'
2+
on:
3+
schedule:
4+
- cron: '30 1 * * *'
5+
6+
jobs:
7+
stale:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/stale@v9
11+
with:
12+
stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.'
13+
days-before-stale: 30
14+
days-before-close: 7
15+
exempt-pr-labels: 'help wanted,enhancement,security,pinned'
16+
stale-pr-label: 'wontfix'
17+
stale-issue-label: 'wontfix'
18+
exempt-issue-labels: 'help wanted,enhancement,security,pinned'

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
.claude/
1+
.claude/
2+
.vscode/launch.json

AsBuiltReport.Core.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Core/master/CHANGELOG.md'
117117

118118
# Prerelease string of this module
119-
# Prerelease = ''
119+
Prerelease = 'RC1'
120120

121121
# Flag to indicate whether the module requires explicit user acceptance for install/update/save
122122
# RequireLicenseAcceptance = $false

AsBuiltReport.Core.psm1

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,14 @@ foreach ($Module in @($Public + $Private)) {
1010
}
1111
}
1212

13+
# Export public functions
1314
Export-ModuleMember -Function $Public.BaseName
14-
Export-ModuleMember -Function $Private.BaseName
15+
16+
# Make helper functions available globally for report modules to use
17+
# This keeps them out of the public API but accessible from report modules
18+
$GlobalFunctions = @('Write-ReportModuleInfo', 'Get-RequiredModule')
19+
foreach ($FunctionName in $GlobalFunctions) {
20+
if (Get-Command -Name $FunctionName -ErrorAction SilentlyContinue) {
21+
Set-Item -Path "Function:\Global:$FunctionName" -Value (Get-Command $FunctionName).ScriptBlock
22+
}
23+
}

CHANGELOG.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,37 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [1.5.0] - Unreleased
8+
## [1.5.0-RC1] - Unreleased
99

1010
### Added
11-
- Multilingual support for AsBuiltReport Core module
11+
- Add multilingual support for AsBuiltReport Core module
1212
- `Initialize-LocalizedData` function to handle localization for both Core and Report modules
1313
- `Resolve-Culture` function with comprehensive culture fallback chains for 135+ culture variants
1414
- Localized user prompts and messages in `New-AsBuiltConfig` function. Support for all main languages.
1515
- `ReportLanguage` parameter added to `New-AsBuiltReport` function with dynamic validation based on available languages in individual report modules
1616
- Support for setting default language in report JSON configuration files using the `Report.Language` property
17+
- Add PowerShell module dependency checking for report modules with `Get-RequiredModule` function
18+
- Add `Draw-AsciiBanner` function to improve user interface in `New-AsBuiltConfig`
19+
- Add `Write-ReportModuleInfo` function to provide information on report modules
20+
- Add `SECURITY.md` and `CODE_OF_CODUCT.md` documentation
21+
- Add `Stale.yml` GitHub workflow to manage GitHub issues
22+
- Add `FUNDING.yml` to provide sponsorship links
1723
- Improve error handling with comprehensive try-catch blocks and meaningful error messages
1824

1925
### Changed
2026
- Core module functions (`New-AsBuiltConfig`, `New-AsBuiltReport`, `New-AsBuiltReportConfig`) now default to user's OS language instead of hardcoded English
2127
- Report modules default to 'en-US' when no other language is supported
22-
- Updated parameter validation to use ValidateScript blocks for dynamic language detection
28+
- Update parameter validation to use ValidateScript blocks for dynamic language detection
29+
- Update `AsBuiltReport.Core.Style.ps1` script to support language translation
2330
- Enhanced error messages to include specific language and module information
2431
- Improved progress messaging during report generation
25-
- Updated all y/n prompts in `New-AsBuiltConfig` to show defaults and handle empty input
32+
- Update all y/n prompts in `New-AsBuiltConfig` to show defaults and handle empty input
2633
- Renamed `MFA` parameter to `UseInteractiveAuth` (`MFA` alias retained for backwards compatibility)
34+
- Update `README.md` and `CONTRIBUTING.md` documentation
35+
- Update `LICENSE`
36+
37+
# Removed
38+
- Remove sample style scripts
2739

2840
## [1.4.3] - 2025-03-08
2941

CODE_OF_CONDUCT.md

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# Code of Conduct
2+
3+
The AsBuiltReport project is committed to fostering an open and welcoming environment for all contributors, users, and community members.
4+
5+
## Our Pledge
6+
7+
We as members, contributors, and leaders pledge to make participation in our
8+
community a harassment-free experience for everyone, regardless of age, body
9+
size, visible or invisible disability, ethnicity, sex characteristics, gender
10+
identity and expression, level of experience, education, socio-economic status,
11+
nationality, personal appearance, race, religion, or sexual identity
12+
and orientation.
13+
14+
We pledge to act and interact in ways that contribute to an open, welcoming,
15+
diverse, inclusive, and healthy community.
16+
17+
## Our Standards
18+
19+
Examples of behavior that contributes to a positive environment for our
20+
community include:
21+
22+
* Demonstrating empathy and kindness toward other people
23+
* Being respectful of differing opinions, viewpoints, and experiences
24+
* Giving and gracefully accepting constructive feedback
25+
* Accepting responsibility and apologizing to those affected by our mistakes,
26+
and learning from the experience
27+
* Focusing on what is best not just for us as individuals, but for the
28+
overall community
29+
30+
Examples of unacceptable behavior include:
31+
32+
* The use of sexualized language or imagery, and sexual attention or
33+
advances of any kind
34+
* Trolling, insulting or derogatory comments, and personal or political attacks
35+
* Public or private harassment
36+
* Publishing others' private information, such as a physical or email
37+
address, without their explicit permission
38+
* Other conduct which could reasonably be considered inappropriate in a
39+
professional setting
40+
41+
## Technical Disagreements
42+
43+
Technical disagreements are a normal part of open source development. When disagreements arise:
44+
45+
* Focus on the technical merits of the solution
46+
* Assume good intentions from all parties
47+
* Seek to understand different perspectives
48+
* Escalate to maintainers if consensus cannot be reached
49+
50+
## Enforcement Responsibilities
51+
52+
Community leaders are responsible for clarifying and enforcing our standards of
53+
acceptable behavior and will take appropriate and fair corrective action in
54+
response to any behavior that they deem inappropriate, threatening, offensive,
55+
or harmful.
56+
57+
Community leaders have the right and responsibility to remove, edit, or reject
58+
comments, commits, code, wiki edits, issues, and other contributions that are
59+
not aligned to this Code of Conduct, and will communicate reasons for moderation
60+
decisions when appropriate.
61+
62+
## Scope
63+
64+
This Code of Conduct applies within all AsBuiltReport community spaces, including:
65+
66+
* GitHub repositories (issues, pull requests, discussions)
67+
* Official social media channels
68+
* Community chat platforms
69+
* Project events and meetups
70+
71+
It also applies when an individual is officially representing the AsBuiltReport community in public spaces.
72+
Examples of representing our community include using an official e-mail address,
73+
posting via an official social media account, or acting as an appointed
74+
representative at an online or offline event.
75+
76+
## Enforcement
77+
78+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
79+
reported to the community leaders responsible for enforcement at
80+
81+
82+
All complaints will be reviewed and investigated promptly and fairly.
83+
84+
All community leaders are obligated to respect the privacy and security of the
85+
reporter of any incident.
86+
87+
## Enforcement Guidelines
88+
89+
Community leaders will follow these Community Impact Guidelines in determining
90+
the consequences for any action they deem in violation of this Code of Conduct:
91+
92+
### 1. Correction
93+
94+
**Community Impact**: Use of inappropriate language or other behavior deemed
95+
unprofessional or unwelcome in the community.
96+
97+
**Consequence**: A private, written warning from community leaders, providing
98+
clarity around the nature of the violation and an explanation of why the
99+
behavior was inappropriate. A public apology may be requested.
100+
101+
### 2. Warning
102+
103+
**Community Impact**: A violation through a single incident or series
104+
of actions.
105+
106+
**Consequence**: A warning with consequences for continued behavior. No
107+
interaction with the people involved, including unsolicited interaction with
108+
those enforcing the Code of Conduct, for a specified period of time. This
109+
includes avoiding interactions in community spaces as well as external channels
110+
like social media. Violating these terms may lead to a temporary or
111+
permanent ban.
112+
113+
### 3. Temporary Ban
114+
115+
**Community Impact**: A serious violation of community standards, including
116+
sustained inappropriate behavior.
117+
118+
**Consequence**: A temporary ban from any sort of interaction or public
119+
communication with the community for a specified period of time. No public or
120+
private interaction with the people involved, including unsolicited interaction
121+
with those enforcing the Code of Conduct, is allowed during this period.
122+
Violating these terms may lead to a permanent ban.
123+
124+
### 4. Permanent Ban
125+
126+
**Community Impact**: Demonstrating a pattern of violation of community
127+
standards, including sustained inappropriate behavior, harassment of an
128+
individual, or aggression toward or disparagement of classes of individuals.
129+
130+
**Consequence**: A permanent ban from any sort of public interaction within
131+
the community.
132+
133+
## Attribution
134+
135+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
136+
version 2.0, available at
137+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
138+
139+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
140+
enforcement ladder](https://github.com/mozilla/diversity).
141+
142+
[homepage]: https://www.contributor-covenant.org
143+
144+
For answers to common questions about this code of conduct, see the FAQ at
145+
https://www.contributor-covenant.org/faq. Translations are available at
146+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)