prepare to release

.github/workflows/release.yml

@@ -3,19 +3,24 @@
 name: Release
 on:
   workflow_dispatch:
-  # when tag is pushed
 
   # temp
-  push:
-    branches:
-      - lsp
+#  push:
+#    branches:
+#      - lsp
 
 env:
   CARGO_INCREMENTAL: 0
   CARGO_NET_RETRY: 10
   RUSTUP_MAX_RETRIES: 10
   CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: aarch64-linux-gnu-gcc
   CARGO_TARGET_ARM_UNKNOWN_LINUX_GNUEABIHF_LINKER: arm-linux-gnueabihf-gcc
+  # should match with version in dist.rs
+  VERSION_STABLE: 0.2
+
+# for git tagging
+permissions:
+  contents: write
 
 jobs:
   dist:
@@ -172,6 +177,9 @@ jobs:
         with:
           node-version: 20
 
+      - run: echo "TAG=${{ env.VERSION_STABLE }}.${{ github.run_number }}" >> $GITHUB_ENV
+      - run: 'echo "TAG: $TAG"'
+
       - uses: actions/download-artifact@v4
         with:
           name: dist-aarch64-apple-darwin
@@ -211,7 +219,20 @@ jobs:
 
       - run: ls -al ./dist
 
-      # TODO: publish release
+      - name: git tag and push
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+          git tag -a $TAG -m "Release $TAG"
+          git push origin $TAG
+
+      - name: Publish release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: ${{ env.TAG }}
+          tag_name: ${{ env.TAG }}
+          files: |
+            dist/*
 
       - uses: pnpm/action-setup@v4
         with:
@@ -227,9 +248,11 @@ jobs:
       - run: pnpm install
         working-directory: clients/vscode
 
-      #      - run: pnpm dlx vsce publish --pat ${{ secrets.VSCE_TOKEN }} --packagePath ../../dist/vscode-fluent-bit-*.vsix
-      #        working-directory: clients/vscode
-      #      - run: pnpm dlx vsce ls --packagePath ../../dist/vscode-fluent-bit-*.vsix
-      #        working-directory: clients/vscode
+      - name: Publish Extension (Code Marketplace)
+        run: pnpm dlx vsce publish --pat ${{ secrets.VSCE_TOKEN }} --packagePath ../../dist/vscode-fluent-bit-*.vsix
+        working-directory: clients/vscode
 
-      # TODO: ovsx
+      - name: Publish Extension (OpenVSX)
+        run: pnpm dlx ovsx publish --pat ${{ secrets.OVSX_TOKEN }} --packagePath ../../dist/vscode-fluent-bit-*.vsix
+        working-directory: clients/vscode
+        timeout-minutes: 2

CONTRIBUTING.md

@@ -1,18 +1,17 @@
-## Contributing to ``
+## Contributing to `fluent-bit-lsp`
+
+🚧 Work-in-progress
+
+### Install
+
+(e.g. using [mise](https://mise.jdx.dev/))
 
-### Install (using [mise](https://mise.jdx.dev/))
 ```sh
 $ mise use node@20
 ```
 
 ### Test
+TBD
 
 ### Release
-
-Tag version with semver (ex. `v0.1.0`)
-
-```shell
-pnpm dlx auto-changelog --output CHANGELOG.md --template keepachangelog
-```
-
-Generate changelog
+see [Release workflow](./.github/workflows/release.yml)

README.md

@@ -1,14 +1,18 @@
 # fluent-bit-lsp
 
-[![Server CI](https://github.com/sh-cho/vscode-fluent-bit/actions/workflows/server-ci.yaml/badge.svg?event=push)](https://github.com/sh-cho/vscode-fluent-bit/actions/workflows/server-ci.yaml)
+[![Server CI](https://github.com/sh-cho/fluent-bit-lsp/actions/workflows/server-ci.yaml/badge.svg?event=push)](https://github.com/sh-cho/fluent-bit-lsp/actions/workflows/server-ci.yaml)
 
 [LSP(Language Server Protocol)](https://microsoft.github.io/language-server-protocol/) implementation
 for [fluent-bit](https://fluentbit.io/) config
 
+> [!NOTE]
+> This project is still in development and not fully-featured yet.
+
 ## Features
 
 - Auto-completion for plugins
 - Show documentation on hover
+- Diagnostics
 
 ## [fluent-bit-language-server](./fluent-bit-language-server)
 
@@ -19,14 +23,15 @@ with [tower-lsp](https://github.com/ebkalderon/tower-lsp), [tree-sitter-fluentbi
 
 - [Visual Studio Code](./clients/vscode)
 - nvim (TBD)
+- helix (TBD)
 
-## Changelog
+## How to contribute?
 
-See [CHANGELOG.md](./CHANGELOG.md)
+Currently, this project is in the early stage of development and a lot of parts can be changed. So I don't think it's a good time to contribute to this project yet.
 
-## How to contribute?
+It doesn't mean that I don't accept contributions now, but I think it's better to wait until the project is more stable.
 
-See [CONTRIBUTING.md](./CONTRIBUTING.md)
+When it is ready, I will update this section. 🙏
 
 ## License
 

clients/vscode/.vscodeignore

@@ -0,0 +1,10 @@
+**
+!images
+!language-configuration.json
+!LICENSE
+!package.json
+!pnpm-lock.yaml
+!README.md
+!server
+!syntaxes
+!out/main.js

clients/vscode/README.md

@@ -2,10 +2,26 @@
 
 [![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/sh-cho.vscode-fluent-bit)](https://marketplace.visualstudio.com/items?itemName=sh-cho.vscode-fluent-bit)
 [![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/sh-cho.vscode-fluent-bit)](https://marketplace.visualstudio.com/items?itemName=sh-cho.vscode-fluent-bit)
-![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/sh-cho.vscode-fluent-bit)
+[![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/sh-cho.vscode-fluent-bit)](https://marketplace.visualstudio.com/items?itemName=sh-cho.vscode-fluent-bit)
 [![Visual Studio Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/sh-cho.vscode-fluent-bit)](https://marketplace.visualstudio.com/items?itemName=sh-cho.vscode-fluent-bit&ssr=false#review-details)
 
-<img width="620" alt="image" src="https://user-images.githubusercontent.com/11611397/236528991-9f3b9ce0-8312-49eb-bacd-7fd6f1104a34.png">
+This extension provide support for [fluent-bit](https://fluentbit.io/) config file, with [LSP(Language Server Protocol)](https://microsoft.github.io/language-server-protocol/) implementation.
 
-## Changelog
-See [CHANGELOG.md](./CHANGELOG.md)
+See [fluent-bit-lsp](https://github.com/sh-cho/fluent-bit-lsp) repository for more information.
+
+## Example
+![image](https://github.com/user-attachments/assets/fe0cd183-2b73-40ca-8b0a-b9e10cb442f5)
+
+## Features
+- Auto-completion for plugins
+- Hover info for entry keys
+- Diagnostics (only for some invalid comment position)
+- Syntax highlighting (using tmLanguage)
+
+## Note
+This extension is not fully-featured and can be buggy since it is still in development.
+
+If you find any bugs or have feature requests, please open an issue on the repository.
+
+## License
+Licensed under either of Apache License Version 2.0 or MIT License at your option.