From d317c98ab748a99c63f1b75d5279bb991b9b6e44 Mon Sep 17 00:00:00 2001 From: Robert Dailey Date: Fri, 1 Dec 2023 11:48:12 -0600 Subject: [PATCH] chore: Relocate utility scripts to a subdirectory To reduce clutter at the root of the repo, utility scripts have been moved to a `scripts` subdirectory. --- CONTRIBUTING.md | 10 +++++----- Commit-Gitignore.ps1 => scripts/Commit-Gitignore.ps1 | 0 Install-Tooling.ps1 => scripts/Install-Tooling.ps1 | 0 Prepare-Release.ps1 => scripts/Prepare-Release.ps1 | 0 Update-Gitignore.ps1 => scripts/Update-Gitignore.ps1 | 0 5 files changed, 5 insertions(+), 5 deletions(-) rename Commit-Gitignore.ps1 => scripts/Commit-Gitignore.ps1 (100%) rename Install-Tooling.ps1 => scripts/Install-Tooling.ps1 (100%) rename Prepare-Release.ps1 => scripts/Prepare-Release.ps1 (100%) rename Update-Gitignore.ps1 => scripts/Update-Gitignore.ps1 (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 98647a11..9e7566b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,8 +33,8 @@ The following tools are *highly recommended* but not strictly required: - Jetbrains Rider (IDE for editing C# code) - Visual Studio Code (install workspace-recommended extensions as well) -Other required tooling can be installed via the `Install-Tooling.ps1` powershell script. It's also a -good idea to occasionally run this for upgrade purposes, too. +Other required tooling can be installed via the `scripts/Install-Tooling.ps1` powershell script. +It's also a good idea to occasionally run this for upgrade purposes, too. ## Docker Development @@ -115,7 +115,7 @@ committed. To make a release, follow these steps: -1. Run `Prepare-Release.ps1`. This will do the following: +1. Run `scripts/Prepare-Release.ps1`. This will do the following: 1. Update the changelog for the release according to [Keep a Changelog][changelog] rules. 1. Commit the changelog updates. 1. Create a tag for the release (using GitVersion). @@ -142,8 +142,8 @@ The Github Workflows manage the release process after the push by doing the foll ## Update `.gitignore` -Execute the `Update-Gitignore.ps1` script using Powershell. The working directory *must* be the root -of the repo. This will pull the latest relevant `.gitignore` patterns from +Execute the `scripts/Update-Gitignore.ps1` script using Powershell. The working directory *must* be +the root of the repo. This will pull the latest relevant `.gitignore` patterns from [gitignore.io](https://gitignore.io) and commit them automatically to your current branch. ## Testing Discord Notifier diff --git a/Commit-Gitignore.ps1 b/scripts/Commit-Gitignore.ps1 similarity index 100% rename from Commit-Gitignore.ps1 rename to scripts/Commit-Gitignore.ps1 diff --git a/Install-Tooling.ps1 b/scripts/Install-Tooling.ps1 similarity index 100% rename from Install-Tooling.ps1 rename to scripts/Install-Tooling.ps1 diff --git a/Prepare-Release.ps1 b/scripts/Prepare-Release.ps1 similarity index 100% rename from Prepare-Release.ps1 rename to scripts/Prepare-Release.ps1 diff --git a/Update-Gitignore.ps1 b/scripts/Update-Gitignore.ps1 similarity index 100% rename from Update-Gitignore.ps1 rename to scripts/Update-Gitignore.ps1