chore: deprecate github/username utility (#1605)

* chore: deprecate github/username utility * Update user.ts
yeoman · Feb 27, 2025 · 284f7a4 · 284f7a4
1 parent aaf053b
commit 284f7a4
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/actions/user.ts b/src/actions/user.ts
@@ -40,9 +40,15 @@ export abstract class GitMixin {
     return this._git;
   }
 
+  /**
+   * @deprecated Will be removed in version 8.
+   * GitHub utilities.
+   */
   get github() {
     return {
       /**
+       * @deprecated Will be removed in version 8. Use 'github-username' package with `await this.git.email()` result instead.
+       *
        * Retrieves GitHub's username from the GitHub API
        * @return Resolved with the GitHub username or rejected if unable to
        *                   get the information