feat: rename to description-to-co-authors; refresh tooling

JoshuaKGoldberg · Aug 10, 2024 · 0817424 · 0817424
1 parent 32004b2
commit 0817424
Show file tree

Hide file tree

Showing 34 changed files with 5,690 additions and 5,503 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -1,30 +1,24 @@
 {
-	"badgeTemplate": "<a href=\"#contributors\" target=\"_blank\"><img alt=\"All Contributors: <%= contributors.length %> 👪\" src=\"https://img.shields.io/badge/all_contributors-<%= contributors.length %>_👪-21bb42.svg\" /></a>",
+	"badgeTemplate": "\t<a href=\"#contributors\" target=\"_blank\"><img alt=\"👪 All Contributors: <%= contributors.length %>\" src=\"https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-<%= contributors.length %>-21bb42.svg\" /></a>",
 	"commit": false,
 	"commitConvention": "angular",
+	"commitType": "docs",
 	"contributors": [
-	  {
-		"avatar_url": "https://avatars.githubusercontent.com/u/3335181?v=4",
-		"contributions": [
-		  "tool",
-		  "bug",
-		  "code",
-		  "maintenance",
-		  "review",
-		  "doc",
-		  "infra"
-		],
-		"login": "JoshuaKGoldberg",
-		"name": "Josh Goldberg",
-		"profile": "http://www.joshuakgoldberg.com"
-	  }
+		{
+			"avatar_url": "https://avatars.githubusercontent.com/u/3335181?v=4",
+			"contributions": ["maintenance"],
+			"login": "JoshuaKGoldberg",
+			"name": "Josh Goldberg",
+			"profile": "http://www.joshuakgoldberg.com"
+		}
 	],
 	"contributorsPerLine": 7,
 	"contributorsSortAlphabetically": true,
 	"files": ["README.md"],
 	"imageSize": 100,
-	"projectName": "commit-to-co-authors",
+	"projectName": "description-to-co-authors",
 	"projectOwner": "JoshuaKGoldberg",
 	"repoHost": "https://github.com",
 	"repoType": "github"
 }
+
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contributing
 
-Thanks for your interest in contributing to `commit-to-co-authors`! 💖
+Thanks for your interest in contributing to `description-to-co-authors`! 💖
 
 > After this page, see [DEVELOPMENT.md](./DEVELOPMENT.md) for local development instructions.
 
@@ -10,7 +10,7 @@ This project contains a [Contributor Covenant code of conduct](./CODE_OF_CONDUCT
 
 ## Reporting Issues
 
-Please do [report an issue on the issue tracker](https://github.com/JoshuaKGoldberg/commit-to-co-authors/issues/new/choose) if there's any bugfix, documentation improvement, or general enhancement you'd like to see in the repository! Please fully fill out all required fields in the most appropriate issue form.
+Please do [report an issue on the issue tracker](https://github.com/JoshuaKGoldberg/description-to-co-authors/issues/new/choose) if there's any bugfix, documentation improvement, or general enhancement you'd like to see in the repository! Please fully fill out all required fields in the most appropriate issue form.
 
 ## Sending Contributions
 
@@ -22,8 +22,8 @@ There are two steps involved:
 
 ### Finding an Issue
 
-With the exception of very small typos, all changes to this repository generally need to correspond to an [unassigned open issue marked as `status: accepting prs` on the issue tracker](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aissue+is%3Aopen+label%3A%22status%3A+accepting+prs%22+no%3Aassignee+).
-If this is your first time contributing, consider searching for [unassigned issues that also have the `good first issue` label](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3A%22status%3A+accepting+prs%22+no%3Aassignee+).
+With the exception of very small typos, all changes to this repository generally need to correspond to an [unassigned open issue marked as `status: accepting prs` on the issue tracker](https://github.com/JoshuaKGoldberg/description-to-co-authors/issues?q=is%3Aissue+is%3Aopen+label%3A%22status%3A+accepting+prs%22+no%3Aassignee+).
+If this is your first time contributing, consider searching for [unassigned issues that also have the `good first issue` label](https://github.com/JoshuaKGoldberg/description-to-co-authors/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3A%22status%3A+accepting+prs%22+no%3Aassignee+).
 If the issue you'd like to fix isn't found on the issue, see [Reporting Issues](#reporting-issues) for filing your own (please do!).
 
 #### Issue Claiming
@@ -42,7 +42,7 @@ Be sure to fill out the pull request template's requested information -- otherwi
 PRs are also expected to have a title that adheres to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0).
 Only PR titles need to be in that format, not individual commits.
 Don't worry if you get this wrong: you can always change the PR title after sending it.
-Check [previously merged PRs](https://github.com/JoshuaKGoldberg/commit-to-co-authors/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.
+Check [previously merged PRs](https://github.com/JoshuaKGoldberg/description-to-co-authors/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.
 
 #### Draft PRs
 

diff --git a/.github/DEVELOPMENT.md b/.github/DEVELOPMENT.md
@@ -3,8 +3,8 @@
 After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo) and [installing pnpm](https://pnpm.io/installation):
 
 ```shell
-git clone https://github.com/<your-name-here>/commit-to-co-authors
-cd commit-to-co-authors
+git clone https://github.com/<your-name-here>/description-to-co-authors
+cd description-to-co-authors
 pnpm install
 ```
 

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,5 +1,5 @@
 <!-- Note: Please must use one of our issue templates to file an issue! 🛑 -->
-<!-- 👉 https://github.com/JoshuaKGoldberg/commit-to-co-authors/issues/new/choose 👈 -->
+<!-- 👉 https://github.com/JoshuaKGoldberg/description-to-co-authors/issues/new/choose 👈 -->
 <!-- **Issues that should have been filed with a template will be closed without action, and we will ask you to use a template.** -->
 
 <!-- This blank issue template is only for issues that don't fit any of the templates. -->

diff --git a/.github/ISSUE_TEMPLATE/01-bug.yml b/.github/ISSUE_TEMPLATE/01-bug.yml
@@ -7,7 +7,7 @@ body:
           required: true
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/commit-to-co-authors/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/description-to-co-authors/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:

diff --git a/.github/ISSUE_TEMPLATE/02-documentation.yml b/.github/ISSUE_TEMPLATE/02-documentation.yml
@@ -5,7 +5,7 @@ body:
       options:
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/commit-to-co-authors/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/description-to-co-authors/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:

diff --git a/.github/ISSUE_TEMPLATE/03-feature.yml b/.github/ISSUE_TEMPLATE/03-feature.yml
@@ -3,11 +3,9 @@ body:
       description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
       label: Bug Report Checklist
       options:
-        - label: I have tried restarting my IDE and the issue persists.
-          required: true
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/commit-to-co-authors/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/description-to-co-authors/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:

diff --git a/.github/ISSUE_TEMPLATE/04-tooling.yml b/.github/ISSUE_TEMPLATE/04-tooling.yml
@@ -7,7 +7,7 @@ body:
           required: true
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/commit-to-co-authors/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/description-to-co-authors/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,12 +1,12 @@
-<!-- 👋 Hi, thanks for sending a PR to commit-to-co-authors! 💖.
+<!-- 👋 Hi, thanks for sending a PR to description-to-co-authors! 💖.
 Please fill out all fields below and make sure each item is true and [x] checked.
 Otherwise we may not be able to review your PR. -->
 
 ## PR Checklist
 
 - [ ] Addresses an existing open issue: fixes #000
-- [ ] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/commit-to-co-authors/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
-- [ ] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/commit-to-co-authors/blob/main/.github/CONTRIBUTING.md) were taken
+- [ ] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/description-to-co-authors/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
+- [ ] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/description-to-co-authors/blob/main/.github/CONTRIBUTING.md) were taken
 
 ## Overview
 

diff --git a/.github/actions/prepare/action.yml b/.github/actions/prepare/action.yml
@@ -5,10 +5,12 @@ name: Prepare
 runs:
   steps:
     - uses: pnpm/action-setup@v2
+      with:
+        version: 9
     - uses: actions/setup-node@v4
       with:
         cache: pnpm
-        node-version: "18"
+        node-version: "20"
     - run: pnpm install --frozen-lockfile
       shell: bash
   using: composite
diff --git a/.github/renovate.json b/.github/renovate.json
@@ -1,8 +1,10 @@
 {
 	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
 	"automerge": true,
-	"internalChecksFilter": "strict",
+	"extends": ["config:best-practices", "replacements:all"],
+	"ignoreDeps": ["codecov/codecov-action"],
 	"labels": ["dependencies"],
-	"minimumReleaseAge": "3 days",
+	"minimumReleaseAge": "7 days",
+	"patch": { "enabled": false },
 	"postUpdateOptions": ["pnpmDedupe"]
 }
diff --git a/.github/workflows/accessibility-alt-text-bot.yml b/.github/workflows/accessibility-alt-text-bot.yml
@@ -1,5 +1,6 @@
 jobs:
   accessibility_alt_text_bot:
+    if: ${{ !endsWith(github.actor, '[bot]') }}
     runs-on: ubuntu-latest
     steps:
       - uses: github/accessibility-alt-text-bot@v1.4.0

diff --git a/.github/workflows/contributors.yml b/.github/workflows/contributors.yml
@@ -8,7 +8,7 @@ jobs:
       - uses: ./.github/actions/prepare
       - env:
           GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
-        uses: JoshuaKGoldberg/all-contributors-auto-action@v0.3.2
+        uses: JoshuaKGoldberg/all-contributors-auto-action@v0.4.3
 
 name: Contributors
 

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -4,7 +4,6 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/prepare
-      - run: pnpm build || true
       - run: pnpm lint
 
 name: Lint

diff --git a/.github/workflows/post-release.yml b/.github/workflows/post-release.yml
@@ -14,8 +14,8 @@ jobs:
 
             The release is available on:
 
-            * [GitHub releases](https://github.com/JoshuaKGoldberg/commit-to-co-authors/releases/tag/{release_tag})
-            * [npm package (@latest dist-tag)](https://www.npmjs.com/package/commit-to-co-authors/v/${{ env.npm_version }})
+            * [GitHub releases](https://github.com/JoshuaKGoldberg/description-to-co-authors/releases/tag/{release_tag})
+            * [npm package (@latest dist-tag)](https://www.npmjs.com/package/description-to-co-authors/v/${{ env.npm_version }})
 
             Cheers! 📦🚀
 

diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,3 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
 npx lint-staged
diff --git a/.npmpackagejsonlintrc.json b/.npmpackagejsonlintrc.json
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-20.9.0
+20.12.2
diff --git a/.prettierignore b/.prettierignore
@@ -1,4 +1,5 @@
 .all-contributorsrc
+.husky/
 coverage/
 lib/
 pnpm-lock.yaml