@kitschpatrol/repo-config 4.1.0 → 4.1.2

package/init/.github/workflows/github-release.yml

@@ -1,4 +1,4 @@
-name: Create Release
+name: Create GitHub Release
 
 on:
   push:
@@ -9,6 +9,10 @@ jobs:
   build:
     name: Create Release
     runs-on: ubuntu-latest
+    env:
+      ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN || secrets.GITHUB_TOKEN }}
+      IS_VALID_COMMIT: false
+      TAG_NAME: ''
 
     steps:
       - name: Checkout
@@ -16,35 +20,48 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Log Token Type
+        run: |
+          if [ ${{ env.ACCESS_TOKEN }} == ${{ secrets.GITHUB_TOKEN }} ]; then
+            echo "🗝️ Authenticated with GitHub Token"
+          else
+            echo "🔑 Authenticated with Personal Access token"
+          fi
+
       - name: Validate Tag and Branch
         id: validation
         run: |
           TAG=$(git tag --contains HEAD | grep '^v[0-9]' | head -n 1)
-          BRANCH=$(git rev-parse --abbrev-ref HEAD)
           echo "🏷️ Tag for commit is: $TAG"
-          echo "🕊️ Current branch is: $BRANCH"
-          if [[ -z "$TAG" || "$BRANCH" != "main" ]]; then
-            echo "is_valid_commit=false" >> $GITHUB_ENV
-            echo "tag_name=''" >> $GITHUB_ENV
+          BRANCH=$(git branch -r --contains tags/${GITHUB_REF_NAME} | grep 'origin/main' | xargs)
+          if [[ -z "$BRANCH" ]]; then
+            echo "🚨 Tag is not on main branch"
+          else
+            echo "🕊️ Current branch is: $BRANCH"
+          fi
+          if [[ -z "$TAG" || -z "$BRANCH" ]]; then
+            echo "IS_VALID_COMMIT=false" >> $GITHUB_ENV
+            echo "TAG_NAME=''" >> $GITHUB_ENV
           else
-            echo "is_valid_commit=true" >> $GITHUB_ENV
-            echo "tag_name=$TAG" >> $GITHUB_ENV
+            echo "IS_VALID_COMMIT=true" >> $GITHUB_ENV
+            echo "TAG_NAME=$TAG" >> $GITHUB_ENV
           fi
 
       - name: Release Notes
-        if: env.is_valid_commit == 'true'
+        if: env.IS_VALID_COMMIT == 'true'
         id: release-notes
         uses: Bullrich/generate-release-changelog@master
 
       - name: Release
-        if: env.is_valid_commit == 'true'
+        if: env.IS_VALID_COMMIT == 'true'
         id: release
         uses: softprops/action-gh-release@v1
         with:
+          token: ${{ env.ACCESS_TOKEN }}
           draft: false
           prerelease: false
-          name: ${{ env.tag_name }}
-          tag_name: ${{ env.tag_name }}
+          name: ${{ env.TAG_NAME }}
+          tag_name: ${{ env.TAG_NAME }}
           body: |
             ${{ steps.release-notes.outputs.changelog }}
           files: |
@@ -57,8 +74,8 @@ jobs:
             changelog.md
 
       - name: Log Release Details
-        if: env.is_valid_commit == 'true'
+        if: env.IS_VALID_COMMIT == 'true'
         run: |
-          echo "📦 Successfully released: ${{ env.tag_name }}"
+          echo "📦 Successfully released: ${{ env.TAG_NAME }}"
           echo "🔗 Release URL: ${{ steps.release.outputs.url }}"
           echo "🪪 Release ID: ${{ steps.release.outputs.id }}"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/repo-config",
-  "version": "4.1.0",
+  "version": "4.1.2",
   "type": "module",
   "description": "Initial repo configuration for @kitschpatrol/shared-config",
   "repository": {

package/readme.md

@@ -4,7 +4,12 @@
 
 It's a `pnpm`-flavored shared config with some essential files for a fresh repo.
 
-This includes [`.npmrc`](https://pnpm.io/npmrc) and `.gitignore` for now.
+This includes the following:
+
+- [`.npmrc`](https://pnpm.io/npmrc) with hoisting patterns for \`shared-config\`\` tool access
+- `.gitignore` with typical patterns
+- `.vscode` extension recommendations (additional settings and recommendations come from other `shared-config` packages)
+- `.github` folder with a workflow for turning vX.X.X tags into GitHub releases
 
 It's needed to work around some hoisting issues related to plugin resolution in the other `@kitschpatrol/shared-config` packages.
 
@@ -37,3 +42,18 @@ Optionally, you can install the package if you think you'll ever want to regener
    ```sh
    pnpm exec repo-config --init
    ```
+
+### GitHub Configuration
+
+There are two options for authenticating the release workflow action:
+
+#### Github Token
+
+1. Ensure that read / write permissions are set for actions on the repository under Settings → Actions → General → Workflow permissions.
+
+#### Personal Access token
+
+If you want releases to come from your account instead of `github_actions`, then:
+
+1. Create a [fine-grained personal access token](https://github.com/settings/tokens?type=beta) in your GitHub account with the "Contents" repository permission set to "Read and Write".
+2. Add the token as a secret to the repository under the key `PERSONAL_ACCESS_TOKEN`.