Merge branch 'main' into public

Author: razor-x

.github/workflows/makenew.yml

@@ -0,0 +1,89 @@
+---
+name: Make New
+
+on:
+  workflow_dispatch:
+    inputs:
+      repo:
+        description: GitHub repository name (new-repo)
+        required: true
+      title:
+        description: Package title (New Package)
+        required: true
+      description:
+        description: Short package description (Foos and bars.)
+        required: true
+
+jobs:
+  repository:
+    name: Create new repository
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Create repository
+        run: |
+          gh extension install mislav/gh-repo-collab
+          gh repo create --internal --disable-wiki --description "$DESCRIPTION" $REPO
+          gh repo edit $REPO --delete-branch-on-merge
+          gh repo edit $REPO --enable-projects=false
+          gh repo-collab add $REPO $CODEOWNER --permission admin
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          CODEOWNER: ${{ github.actor }}
+          REPO: seamapi/${{ github.event.inputs.repo }}
+          DESCRIPTION: ${{ github.event.inputs.description }}
+  bootstrap:
+    name: Bootstrap repository
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    needs: repository
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Import GPG key
+        uses: crazy-max/ghaction-import-gpg@v5
+        with:
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+          git_committer_name: ${{ secrets.GIT_USER_NAME }}
+          git_committer_email: ${{ secrets.GIT_USER_EMAIL }}
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.GPG_PASSPHRASE }}
+      - name: Replace makenew boilerplate
+        run: ./makenew.sh
+        env:
+          CI: 'true'
+          mk_codeowner: ${{ github.actor }}
+          mk_repo: ${{ github.event.inputs.repo }}
+          mk_slug: '@seamapi/${{ github.event.inputs.repo }}'
+          mk_title: ${{ github.event.inputs.title }}
+          mk_description: ${{ github.event.inputs.description }}
+      - name: Set origin
+        run: |
+          git remote add origin $ORIGIN
+          git config --add --bool push.autoSetupRemote true
+        env:
+          ORIGIN: https://github.com/seamapi/${{ github.event.inputs.repo }}.git
+      - name: Commit
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          skip_fetch: true
+          skip_checkout: true
+          commit_message: Replace makenew boilerplate
+          commit_user_name: ${{ secrets.GIT_USER_NAME }}
+          commit_user_email: ${{ secrets.GIT_USER_EMAIL }}
+          commit_author: ${{ secrets.GIT_USER_NAME }} <${{ secrets.GIT_USER_EMAIL }}>
+  version:
+    name: Cut initial version
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    needs: bootstrap
+    steps:
+      - name: Cut version
+        run: gh workflow run version.yml --repo $REPO --raw-field version=patch
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          REPO: seamapi/${{ github.event.inputs.repo }}

.gitignore

@@ -9,6 +9,7 @@
 *.d.ts
 *.js
 *.js.map
+!src/**/*.d.ts
 !ava.config.js
 
 # Build directories

README.md

@@ -53,36 +53,13 @@ Bootstrap a new TypeScript module in five minutes or less.
 
 ### Bootstrapping a new project
 
-1. Create an empty (**non-initialized**) repository on GitHub.
-2. Clone the main branch of this repository with
-   ```
-   $ git clone --single-branch git@github.com:seamapi/makenew-tsmodule.git <new-ts-module>
-   $ cd <new-ts-module>
-   ```
-   Optionally, reset to the latest version with
-   ```
-   $ git reset --hard <version-tag>
-   ```
-3. Run
-   ```
-   $ ./makenew.sh
-   ```
-   This will replace the boilerplate, delete itself,
-   remove the git remote, remove upstream tags,
-   and stage changes for commit.
-4. Create the required GitHub repository secrets.
-5. Review, commit, and push the changes to GitHub with
-   ```
-   $ git diff --cached
-   $ git commit -m "Replace makenew boilerplate"
-   $ git remote add origin git@github.com:<user>/<new-node-lib>.git
-   $ git push -u origin main
-   ```
-6. Ensure the GitHub action passes,
-   then publish the initial version of the package with
-   ```
-   $ gh workflow run version.yml --raw-field version=patch
-   ```
+1. [Trigger a makenew workflow from this repository][makenew workflow]. 🚀
+   - Provide a value for each required input.
+   - There are no defaults.
+   - Example values are shown in parentheses.
+2. When the workflow completes, clone your new repo and start coding!
+
+[makenew workflow]: https://github.com/seamapi/makenew-tsmodule/actions/workflows/makenew.yml
 
 ### Updating from this skeleton
 

makenew.sh

@@ -9,7 +9,7 @@ find_replace () {
 }
 
 sed_insert () {
-  sed -i.sedbak -e "$2\\"$'\n'"$3"$'\n' $1
+  sed -i.sedbak -e "$2\\""$3" $1
   rm $1.sedbak
 }
 
@@ -37,6 +37,7 @@ stage_env () {
   git remote rm origin
   echo
   git rm -f makenew.sh
+  git rm -f .github/workflows/makenew.yml
   echo
   echo 'Staging changes.'
   git add --all
@@ -46,22 +47,24 @@ stage_env () {
 }
 
 makenew () {
-  echo 'Answer all prompts.'
-  echo 'There are no defaults.'
-  echo 'Example values are shown in parentheses.'
-  read -p '> Your GitHub username (my-user): ' mk_codeowner
-  read -p '> Package title (My Package): ' mk_title
-  read -p '> Package name (@seamapi/my-package): ' mk_slug
-  read -p '> Short package description (Foos and bars.): ' mk_description
-  read -p '> GitHub repository name (my-repo): ' mk_repo
+  if [[ -z "${CI:-}" ]]; then
+    echo 'Answer all prompts.'
+    echo 'There are no defaults.'
+    echo 'Example values are shown in parentheses.'
+    read -p '> Your GitHub username (my-user): ' mk_codeowner
+    read -p '> GitHub repository name (new-repo): ' mk_repo
+    read -p '> Package name (@seamapi/new-package): ' mk_slug
+    read -p '> Package title (New Package): ' mk_title
+    read -p '> Short package description (Foos and bars.): ' mk_description
+  fi
 
-  sed_delete README.md '10,103d'
+  sed_delete README.md '10,80d'
   sed_insert README.md '10i' 'TODO'
 
   find_replace "s/^  \"version\": \".*\"/  \"version\": \"0.0.0\"/g"
   find_replace "s/TypeScript Module Package Skeleton/${mk_title}/g"
   find_replace "s/Package skeleton for a TypeScript module\./${mk_description}/g"
-  find_replace "s/@seambot/${mk_codeowner}/g"
+  find_replace "s/@seambot/@${mk_codeowner}/g"
   find_replace "s|@seamapi/makenew-tsmodule|${mk_slug}|g"
   find_replace "s|makenew-tsmodule|${mk_repo}|g"