feat: releases (#260)

* feat: bootstrap release please * docs: add instruction to install a tag/release via tpm * chore: add `tmux.conf` placeholder for bug template * docs: add CONTRIBUTING.md Copied from https://github.com/catppuccin/nix/blob/3fdc011242c684c48ed96d91e77c74e760aedc3e/CONTRIBUTING.md * refactor: change vlatest to latest * docs: remove merge instructions * docs: use full version as tag msg
catppuccin · Aug 4, 2024 · 5fbacdf · 5fbacdf
1 parent 408c02c
commit 5fbacdf
Show file tree

Hide file tree

Showing 6 changed files with 113 additions and 1 deletion.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -20,6 +20,13 @@ body:
     attributes:
       label: Paste your configuration.
       description: Provide us with the contents of your `.tmux.conf` file.
+      placeholder: |
+        ```sh
+        set -g @plugin 'catppuccin/tmux'
+        set -g @plugin 'tmux-plugins/tpm'
+        # ...
+        run ~/.config/tmux/tpm/tpm
+        ```
     validations:
       required: true
   - type: textarea

diff --git a/.github/release-please-config.json b/.github/release-please-config.json
@@ -0,0 +1,13 @@
+{
+  "last-release-sha": "408c02ccf44d0a59a7a63ce2b65c5c29982c5c0e",
+  "packages": {
+    ".": {
+      "release-type": "simple",
+      "changelog-path": "CHANGELOG.md",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": false,
+      "draft": true
+    }
+  },
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}
diff --git a/.github/release-please-manifest.json b/.github/release-please-manifest.json
@@ -0,0 +1,3 @@
+{
+  ".": "0.0.1"
+}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,45 @@
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+name: release-please
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          config-file: .github/release-please-config.json
+          manifest-file: .github/release-please-manifest.json
+      - uses: actions/checkout@v4
+      - name: tag major and minor versions
+        if: ${{ steps.release.outputs.release_created }}
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+          git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/googleapis/release-please-action.git"
+
+          git tag -d latest || true
+          git tag -d v${{ steps.release.outputs.major }} || true
+          git tag -d v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true
+
+          git push origin :latest || true
+          git push origin :v${{ steps.release.outputs.major }} || true
+          git push origin :v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true
+
+          git tag -a latest -m "Release v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}"
+          git tag -a v${{ steps.release.outputs.major }} -m "Release v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}"
+          git tag -a v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} -m "Release v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}"
+
+          git push origin latest
+          git push origin v${{ steps.release.outputs.major }}
+          git push origin v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,43 @@
+# Contributing
+
+## Adding a module
+
+Follow the instructions from [custom](/custom), place the module in the appropriate
+directory and document the module in `README.md`.
+
+## Commit messages
+
+This repository uses [Conventional Commits](https://conventionalcommits.org).
+Commit headers should be lowercase. Most commits should include a body that briefly
+describes the motivation and content of the commit.
+
+### Commit types
+
+- `fix`: A bug fix that doesn't modify the public API
+- `feat`: A code change that modifies the public API
+- `refactor`: A code change that doesn't change behavior
+- `style`: A style fix or change
+- `docs`: Any change to documentation
+- `ci`: Any change to CI files
+- `revert`: A revert commit. The message should describe the reasoning and the
+  commit should include the `Refs:` footer with the short hashes of the commits
+  being reverted.
+- `chore`: catch-all type
+
+### Commit scopes
+
+Available commit scopes are module names, `status`, `pane`, and
+`window`. If none of these apply, omit the scope.
+
+### Breaking changes
+
+All breaking changes should be documented in the commit footer in the format
+described by Conventional Commits. Use the `<type>!` syntax in order to distinguish
+breaking commits in the log, but include the footer to provide a better description
+for the changelog generator.
+
+```
+feat(bar)!: foo the bars
+
+BREAKING CHANGE: bars are now foo'ed
+```
diff --git a/README.md b/README.md
@@ -55,7 +55,8 @@ If you do not have a patched font installed, you can override or remove any icon
 2. Add the Catppuccin plugin:
 
 ```bash
-set -g @plugin 'catppuccin/tmux'
+set -g @plugin 'catppuccin/tmux#latest' # See https://github.com/catppuccin/tmux/tags for additional tags
+# set -g @plugin 'catppuccin/tmux' # main branch
 # ...alongside
 set -g @plugin 'tmux-plugins/tpm'
 ```