-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
…line-with-others #60 Bring this repo in-line with others
- Loading branch information
Showing
21 changed files
with
1,046 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# <title> | ||
|
||
<!-- | ||
Thank you for taking the time to contribute to this project. | ||
Please, fill in all the sections. | ||
Replace items surrounded by chevrons appropriately. | ||
--> | ||
|
||
## Issue | ||
|
||
This PR addresses Issue #<issue-number>. | ||
|
||
<!-- Fill in any additional notes about the PR here --> | ||
|
||
## Check list | ||
|
||
### Required | ||
|
||
- [ ] I have updated `release-notes/wip-release-notes.md` file | ||
- [ ] I have addressed style warnings given by Visual Studio/ReSharper/Rider | ||
- [ ] I have checked that all tests pass. | ||
|
||
### Optional | ||
|
||
<!-- | ||
Depending on what the PR is for these may not be needed. | ||
If any of these items are not needed, then they can be removed. | ||
--> | ||
|
||
- [ ] I have updated the `readme.md` file | ||
- [ ] I have bumped the version number in the `version.txt` | ||
- [ ] I have added or updated any necessary tests. | ||
- [ ] I have ensured that any new code is covered by tests where reasonably possible. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# .readthedocs.yml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Build documentation in the docs/ directory with Sphinx | ||
sphinx: | ||
configuration: docs/conf.py | ||
builder: html | ||
fail_on_warning: true | ||
|
||
# Build documentation with MkDocs | ||
#mkdocs: | ||
# configuration: mkdocs.yml | ||
|
||
# Optionally build your docs in additional formats such as PDF | ||
# formats: | ||
|
||
# Optionally set the version of Python and requirements required to build your docs | ||
# python: | ||
# version: 3.7 | ||
# install: | ||
# - requirements: docs/requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{ | ||
"cSpell.words": [ | ||
"Gedcom", | ||
"Stravaig", | ||
"nuget", | ||
"nupkg", | ||
"pwsh", | ||
"snupkg" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
[CmdletBinding()] | ||
param ( | ||
[Switch] | ||
$BumpMajor, | ||
|
||
[Switch] | ||
$BumpMinor, | ||
|
||
[Switch] | ||
$BumpPatch | ||
) | ||
|
||
$VersionFile = "$PSScriptRoot/version.txt"; | ||
$currentVersion = Get-Content $VersionFile -ErrorAction Stop | ||
if ($null -eq $currentVersion) | ||
{ | ||
Write-Error "The $VersionFile file is empty" | ||
Exit 1 | ||
} | ||
if ($currentVersion.GetType().BaseType.Name -eq "Array") | ||
{ | ||
$currentVersion = $currentVersion[0] | ||
Write-Warning "$VersionFile contains more than one line of text. Using the first line." | ||
} | ||
if ($currentVersion -notmatch "^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$") | ||
{ | ||
Write-Error "The contents of $VersionFile (`"$nextVersion`") not recognised as a valid version number." | ||
Exit 2 | ||
} | ||
|
||
$parts = $currentVersion.Split('.'); | ||
[int]$major = $parts[0] | ||
[int]$minor = $parts[1] | ||
[int]$patch = $parts[2] | ||
|
||
if ($BumpMajor) | ||
{ | ||
$major += 1; | ||
} | ||
|
||
if ($BumpMinor) | ||
{ | ||
$minor += 1; | ||
} | ||
|
||
if ($BumpPatch) | ||
{ | ||
$patch += 1; | ||
} | ||
|
||
$newVersion = "$major.$minor.$patch"; | ||
|
||
Set-Content $VersionFile $newVersion -Encoding UTF8 -Force |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
$content = @( | ||
"# Release Notes", | ||
"", | ||
"## Version X", | ||
"", | ||
"Date: ???", | ||
"" | ||
"### Bugs" | ||
"", | ||
"### Features", | ||
"", | ||
"### Miscellaneous", | ||
"" | ||
) | ||
|
||
Set-Content "$PSScriptRoot/release-notes/wip-release-notes.md" $content -Encoding UTF8 -Force |
Oops, something went wrong.