Merge branch 'main' into update-dev-container

Author: jeviet

.github/ISSUE_TEMPLATE/04_bug.md

@@ -6,6 +6,16 @@ labels: bug
 assignees:
 ---
 
+ 🚨 Please Read Before Posting 🚨 
+ 
+ You are currently in a PUBLIC REPOSITORY. 
+ 
+ No Internal Information: Do not share links to internal Zendesk tickets, repositories, team names, or any internal
+ details. 
+ 
+ Confidentiality Matters: Remember that this repository is visible to the public. Avoid posting anything that should 
+ remain confidential or private.
+
 ## Description
 
 <!-- Include Screenshots or relevant code paths! -->

CONTRIBUTING.md

@@ -20,6 +20,34 @@ Use the [Discussions](https://github.com/github/gh-gei/discussions) tab in this
 
 All work done by the maintainers of this repo is tracked in this repo using Issues. We have a hierarchical backlog with Epics at the top, broken down into Batches then broken down to Tasks (epic/batch/task is indicated via labels on the issues). You can see an example Epic and navigate down from there [here](https://github.com/github/gh-gei/issues/101).
 
+## Running tests 
+
+### In the terminal
+If you want to run tests selectively in the terminal, you can use dotnet test with `--filter` option.
+
+Here are some examples:
+1. Run all tests in `AdoApiTests` class. Navigate to either `src` (where the `sln` file is) or `src/octoshiftcli.tests` (where the `csproj` file is) and then execute the following command:
+ ```
+ dotnet test --filter AdoApiTests
+ ```
+
+2. Run a specific test-`GetUserId_Should_Return_UserId` in `src/OctoshiftCLI.Tests/Octoshift/Services/AdoApiTests`. Navigate to `src` or `src/octoshiftcli.tests` and then execute the following command:
+```
+dotnet test --filter AdoApiTests.GetUserId_Should_Return_UserId
+```
+
+### Debugger 
+
+If you are using VS code, you can install the [C# dev kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) which will add the testing extension. 
+- Press the play to run the entire test suite, or navigate to the specific test you would like to run. 
+- If you set a breakpoint within your code and press the play button with the bug next to it you will be able to inspect your code in more detial. 
+
+### Useful links 
+1. [Dotnet test commands](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-test#filter-option-details)
+2. [Run selective unit tests](https://learn.microsoft.com/en-us/dotnet/core/testing/selective-unit-tests?pivots=mstest)
+3. [C# dev kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)
+ 
+
 
 ## Debugging code 
 

LATEST-VERSION.txt

@@ -1 +1 @@
-v1.4.0
+v1.8.0

README.md

@@ -87,6 +87,10 @@ Refer to the [official documentation](https://docs.github.com/en/migrations/usin
 
 Refer to the [official documentation](https://docs.github.com/en/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-bitbucket-server-to-github-enterprise-cloud) for more details.
 
+### Skipping version checks
+
+When the CLI is launched, it logs if a newer version of the CLI is available. You can skip this check by setting the `GEI_SKIP_VERSION_CHECK` environment variable to `true`. 
+
 ### Skipping GitHub status checks
 
 When the CLI is launched, it logs a warning if there are any ongoing [GitHub incidents](https://www.githubstatus.com/) that might affect your use of the CLI. You can skip this check by setting the `GEI_SKIP_STATUS_CHECK` environment variable to `true`. 

docs/ContributingCode.md

@@ -68,11 +68,18 @@ There are 3 types of static analysis that are enforced on every PR:
 ## Publishing a Release
 Only repo maintainers can publish a release. The process is kicked off by pushing a tag in the format `v0.7`. We follow [Semantic Versioning](https://semver.org/) when deciding on the next version number.
 
-This will trigger an Actions workflow that results in a new release being published. It performs these steps:
-- Validates that the SHA referenced by the tag is in the history of the `main` branch
-- Runs `publish.ps1` to build self-contained binaries for each platform. This script also embeds the version number (extracted from the tag) into each binary.
-- Creates a release in this repo with the self-contained binaries, uses the contents of `RELEASENOTES.md` as the release description.
-- Moves the contents of `RELEASENOTES.md` to a version specific file under the releasenotes folder, then empties out `RELEASENOTES.md` and commits the 2 files
+### How to publish a release
+
+1. Check [`RELEASENOTES.md`](http://releasenotes.md/) to see if there is anything to release.
+2. Switch to the `main` branch and `pull` the latest.
+3. *optional* List the tags e.g. `git tag`
+4. Tag the version e.g. `git tag v5.0`
+5. Push the tags up e.g. `git push --tags`
+6. This will trigger an Actions workflow that results in a new release being published, once the build is done it will wait for approval(from maintainers) in order to `pushlish` the binaries. The workflow does the following steps:
+    - Validates that the SHA referenced by the tag is in the history of the `main` branch
+    - Runs `publish.ps1` to build self-contained binaries for each platform. This script also embeds the version number (extracted from the tag) into each binary.
+    - Creates a release in this repo with the self-contained binaries, uses the contents of `RELEASENOTES.md` as the release description.
+    - Moves the contents of `[RELEASENOTES.md](http://RELEASENOTES.md)` to a version specific file under the name of the created `tag` in the releasenotes folder, then empties out `RELEASENOTES.md` and commits the 2 files.
 
 ## Development Basics
 

releasenotes/v1.5.0.md

@@ -0,0 +1,2 @@
+- Redact `X-Amz-Credential` querystring parameters in AWS S3 URLs included in logs
+- When redacting sensitive patterns in log output, use a non-case sensitive search

releasenotes/v1.6.0.md

@@ -0,0 +1,2 @@
+
+- Skip latest version check on startup if environment variable `GEI_SKIP_VERSION_CHECK` is set to `true`

releasenotes/v1.7.0.md

@@ -0,0 +1,2 @@
+- Add new `gh [gei|bbs2gh|ado2gh] abort-migration` command to cancel a migration that is in the queue or in progress
+- Fix suggested command for downloading logs in `gh gei migrate-repo` log output

releasenotes/v1.7.1.md

@@ -0,0 +1,2 @@
+- Update `bbs2gh inventory-report` help text to document that personal repositories owned by users are not supported
+- Update `ado2gh lock-repo` help text to document the scopes required for your Azure DevOps personal access token

releasenotes/v1.8.0.md

@@ -0,0 +1,2 @@
+- Add `--target-api-url` to commonly used commands to support newer GitHub migration paths.
+- Fixed `gh ado2gh rewire-pipeline` command for ADO Team Projects with more than 10,000 Build Definitions.