feat(cd): remove homemade release script (#6)

## 📃 Summary Now that we have the automated release process, we don't need the custom part anymore
jokajak · Jan 5, 2023 · 316de3d · 316de3d
1 parent 85cb257
commit 316de3d
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 97 deletions.
diff --git a/.chglog/config.yml b/.chglog/config.yml
diff --git a/.chglog/template.md b/.chglog/template.md
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -86,10 +86,13 @@ jobs:
           release-type: simple
           package-name: YOUR_REPOSITORY_NAME
 
-      - name: tag new release
+      - name: tag stable versions
         if: ${{ steps.release.outputs.release_created }}
         run: |
           git config user.name github-actions[bot]
           git config user.email github-actions[bot]@users.noreply.github.com
           git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/google-github-actions/release-please-action.git"
-          NEXT_TAG="${{ steps.release.outputs.version }}" make release
+          git tag -d stable || true
+          git push origin :stable || true
+          git tag -a stable -m "Last Stable Release"
+          git push origin stable
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/Makefile b/Makefile
@@ -29,14 +29,6 @@ documentation-ci: deps documentation
 lint:
 	stylua .
 
-# runs the release script, go to file to see more details.
-release:
-	./scripts/release.sh
-
-# generates a changelog, used by the `release` script.
-changelog:
-	git-chglog -o CHANGELOG.md -no-case
-
 # setup
 setup:
 	./scripts/setup.sh
diff --git a/README.md b/README.md
@@ -10,27 +10,25 @@
 
 - interactive `setup` script
 - README.md template
-- GitHub Release script
 - Perfect for open-source:
   - CODEOWNERS file for PR auto-assign
   - Issues and PR templates
-- CI with GitHub actions:
+- CD leveraging [release-please-action](https://github.com/google-github-actions/release-please-action)
+- CI:
   - Test running on multiple Neovim version
   - Lint check
   - Documentation generation check
   - Minimal run time, ideal for free plans
 - Docs with [mini.nvim `doc` plugin](https://github.com/echasnovski/mini.nvim/blob/main/lua/mini/doc.lua)
 - Tests with [mini.nvim `test` plugin](https://github.com/echasnovski/mini.nvim/blob/main/lua/mini/test.lua)
 - Linting with [Stylua](https://github.com/JohnnyMorganz/StyLua)
-- Changelog with [git-chglog](https://github.com/git-chglog/git-chglog)
 
 ## 📋 Installation
 
 > **Note**:
-> This section is only required if you wish to use the linter and changelog generator provided by the template.
+> This section is only required if you wish to use the linter provided by the template.
 
 - [Install Stylua linter](https://github.com/JohnnyMorganz/StyLua#installation)
-- [Install git-chglog generator](https://github.com/git-chglog/git-chglog)
 
 ## ☄ Getting started
 
@@ -93,10 +91,10 @@ mv README_TEMPLATE.md README.md
 :vimgrep /your-plugin-name/ **/* .github/**
 :cfdo %s/your-plugin-name/my-awesome-plugin/g | update
 
-:vimgrep /YOUR_GITHUB_USERNAME/ .chglog/** .github/** **/*.md
+:vimgrep /YOUR_GITHUB_USERNAME/ .github/** **/*.md
 :cfdo %s/YOUR_GITHUB_USERNAME/shortcuts/g | update
 
-:vimgrep /YOUR_REPOSITORY_NAME/ .chglog/** **/*.md
+:vimgrep /YOUR_REPOSITORY_NAME/ **/*.md
 :cfdo %s/YOUR_REPOSITORY_NAME/my-awesome-plugin.nvim/g | update
 ```
 

diff --git a/scripts/release.sh b/scripts/release.sh
diff --git a/scripts/setup.sh b/scripts/setup.sh
@@ -54,5 +54,5 @@ PASCAL_CASE_PLUGIN_NAME=$(echo "$PLUGIN_NAME" | perl -pe 's/(^|-)./uc($&)/ge;s/-
 
 grep -rl "YourPluginName" .github/ plugin/ tests/ lua/ | xargs sed -i "" -e "s/YourPluginName/$PASCAL_CASE_PLUGIN_NAME/g"
 grep -rl "your-plugin-name" README.md .github/ plugin/ tests/ lua/ | xargs sed -i "" -e "s/your-plugin-name/$PLUGIN_NAME/g"
-grep -rl "YOUR_GITHUB_USERNAME" README.md .github/ .chglog/ | xargs sed -i "" -e "s/YOUR_GITHUB_USERNAME/$USERNAME/g"
-grep -rl "YOUR_REPOSITORY_NAME" README.md .github/ .chglog/ | xargs sed -i "" -e "s/YOUR_REPOSITORY_NAME/$REPOSITORY_NAME/g"
+grep -rl "YOUR_GITHUB_USERNAME" README.md .github/ | xargs sed -i "" -e "s/YOUR_GITHUB_USERNAME/$USERNAME/g"
+grep -rl "YOUR_REPOSITORY_NAME" README.md .github/ | xargs sed -i "" -e "s/YOUR_REPOSITORY_NAME/$REPOSITORY_NAME/g"