Merge pull request #28 from ichoosetoaccept/feat/github-release-notes

update: migrate to GitHub Releases with simplified labels
ichoosetoaccept · Dec 15, 2024 · a4c773e · a4c773e
2 parents 9bab91c + e2c78d3
commit a4c773e
Show file tree

Hide file tree

Showing 22 changed files with 96 additions and 36 deletions.
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,18 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+      - duplicate
+      - wontfix
+    authors:
+      - dependabot
+  categories:
+    - title: 📚 Content
+      labels:
+        - content
+    - title: 🛠 Maintenance
+      labels:
+        - meta
+    - title: Other Changes
+      labels:
+        - "*"
diff --git a/.github/workflows/auto-release.yml b/.github/workflows/auto-release.yml
@@ -15,8 +15,8 @@ name: Auto Release
 
 on:
   pull_request:
-    types: [opened, reopened, edited]
-    branches: [main, feature/update]
+    types: [opened, closed]
+    branches: [main]
   schedule:
     - cron: '0 0 * * *'  # Run daily to check for needed releases
 
@@ -108,3 +108,21 @@ jobs:
           fi
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create tag and release
+        if: github.event.pull_request.merged == true && startsWith(github.event.pull_request.title, 'release:')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          # Get version from package.json
+          VERSION=$(npm pkg get version | tr -d '"')
+          
+          # Create and push tag
+          git tag -a $VERSION -m "Release $VERSION"
+          git push origin $VERSION
+          
+          # Create GitHub Release with auto-generated notes
+          gh release create $VERSION \
+            --title "Release $VERSION" \
+            --generate-notes \
+            --target main
diff --git a/.github/workflows/create-release-tag.yml b/.github/workflows/create-release-tag.yml
@@ -0,0 +1,34 @@
+# This workflow creates git tags when release PRs are merged.
+# It ensures that each release has a corresponding git tag,
+# making it easier to track versions and generate changelogs.
+
+name: Create Release Tag
+
+on:
+  pull_request:
+    types: [closed]
+    branches: [main]
+
+jobs:
+  create-tag:
+    # Only run this job if the PR was merged and has 'release:' in the title
+    if: github.event.pull_request.merged == true && startsWith(github.event.pull_request.title, 'release:')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Create and push tag
+        run: |
+          # Get version from package.json
+          VERSION=$(npm pkg get version | tr -d '"')
+          
+          # Create annotated tag
+          git tag -a $VERSION -m "Release $VERSION"
+          git push origin $VERSION
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,13 @@
 # Changelog
 
+> **Note**: As of December 2024, we have migrated to using GitHub Releases for our changelog.
+> Please visit our [Releases page](https://github.com/ichoosetoaccept/awesome-windsurf/releases) for the latest changes.
+> This file is kept for historical purposes only.
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+and this project adheres to [Calendar Versioning](https://calver.org/) (YYYY.MM.PATCH).
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -85,33 +85,25 @@ Every contribution makes Windsurf better for everyone. Don't hesitate to:
    - You don't need to edit the CHANGELOG.md file manually
    - For releases, add the 'release' label to your PR to create a version tag
 
-## Releases and Versioning
+## Release Process
 
-We use Calendar Versioning (CalVer) with the format `YYYY.MM.PATCH`. Releases are managed entirely through GitHub Actions to ensure consistency:
+We use GitHub Releases to document changes to this repository. Each release follows the Calendar Versioning format (YYYY.MM.PATCH).
 
-### Automated Releases
+### Pull Request Labels
 
-A GitHub Action monitors changes and automatically proposes releases when:
+To help organize our releases, we use a simple labeling system:
 
-- More than 5 files have changed since last release, or
-- More than 10 commits have been made since last release
+- `content`: For documentation, guides, and content changes
+- `meta`: For repository maintenance and workflow changes
 
-The Action will:
+### Creating a Release
 
-1. Calculate the next version number
-2. Update package.json
-3. Generate the changelog
-4. Create a PR with all changes
+Releases are automatically generated based on merged pull requests and their labels. The process is:
 
-### Manual Releases
-
-To manually trigger a release:
-
-1. Create a new PR
-2. Use "release:" in the PR title (e.g., "release: add new feature X")
-3. The same GitHub Action will handle version bumping and changelog updates
-
-All releases go through PRs and the merge queue, ensuring proper review and consistency.
+1. PRs are labeled appropriately during review
+2. When ready for a release, we create a new GitHub Release
+3. Release notes are automatically generated based on PR labels
+4. The release version follows YYYY.MM.PATCH format
 
 ## Contributing Prompts
 

diff --git a/package.json b/package.json
@@ -5,14 +5,12 @@
   "private": false,
   "devDependencies": {
     "@commitlint/cli": "^19.6.0",
-    "auto-changelog": "^2.5.0",
     "husky": "^9.1.7",
     "lint-staged": "^15.2.11",
     "markdownlint-cli2": "^0.16.0"
   },
   "scripts": {
-    "postinstall": "husky",
-    "version": "auto-changelog -p && git add CHANGELOG.md"
+    "postinstall": "husky"
   },
   "lint-staged": {
     "*.md": "markdownlint-cli2"

diff --git a/test-files/auto1.txt b/test-files/auto1.txt
@@ -0,0 +1 @@
+Test file for automatic release testing - file 1
diff --git a/test-files/auto2.txt b/test-files/auto2.txt
@@ -0,0 +1 @@
+Test file for automatic release testing - file 2
diff --git a/test-files/auto3.txt b/test-files/auto3.txt
@@ -0,0 +1 @@
+Test file for automatic release testing - file 3
diff --git a/test-files/auto4.txt b/test-files/auto4.txt
@@ -0,0 +1 @@
+Test file for automatic release testing - file 4
diff --git a/test-files/auto5.txt b/test-files/auto5.txt
@@ -0,0 +1 @@
+Test file for automatic release testing - file 5
diff --git a/test-files/auto6.txt b/test-files/auto6.txt
@@ -0,0 +1 @@
+Test file for automatic release testing - file 6
diff --git a/test-files/test1.txt b/test-files/test1.txt
diff --git a/test-files/test10.txt b/test-files/test10.txt
diff --git a/test-files/test2.txt b/test-files/test2.txt
diff --git a/test-files/test3.txt b/test-files/test3.txt
diff --git a/test-files/test4.txt b/test-files/test4.txt
diff --git a/test-files/test5.txt b/test-files/test5.txt
diff --git a/test-files/test6.txt b/test-files/test6.txt
diff --git a/test-files/test7.txt b/test-files/test7.txt
diff --git a/test-files/test8.txt b/test-files/test8.txt
diff --git a/test-files/test9.txt b/test-files/test9.txt
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Test file for automatic release testing - file 1