Skip to content

Commit

Permalink
setup release (#1)
Browse files Browse the repository at this point in the history
* setup release

* fix lint
  • Loading branch information
glowingjade authored Oct 11, 2024
1 parent c26bac8 commit 986468a
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 18 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Release Obsidian plugin

on:
push:
tags:
- '*'

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version: '18.x'

- name: Build plugin
run: |
npm install
npm run build
- name: Create release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
tag="${GITHUB_REF#refs/tags/}"
gh release create "$tag" \
--title="$tag" \
--draft \
main.js manifest.json styles.css
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Heesu Suh

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Obsidian Smart Composer

`<GIF>`

Everytime we ask ChatGPT, we need to put so much context information for each query. Why spend time putting background infos that are already in your vault?

Obsidian Smart Composer is a plugin that helps you write efficiently with AI by easily referencing your vault content. Inspired by Cursor AI and ChatGPT Canvas, this plugin unifies your note-taking and content creation process within Obsidian.
Expand All @@ -10,17 +8,13 @@ Obsidian Smart Composer is a plugin that helps you write efficiently with AI by

### Contextual Chat

`<GIF>`

Upgrade your note-taking experience with our Contextual AI Assistant, inspired by Cursor AI. Unlike typical AI plugins, our assistant allows you to precisely select the context for your interactions:

- Type `@<filename>` to choose specific files as your conversation context
- Get responses based on selected vault content

### Apply Edit

`<GIF>`

Smart Composer suggests edits to your document, you can apply with a single click.

- Offers document change recommendations
Expand Down Expand Up @@ -49,16 +43,14 @@ Currently, Obsidian Smart Composer is available through manual installation only

Note: The plugin requires a valid API key to work.


### Commands and Hotkeys

Obsidian Smart Composer adds a few commands to work with AI. You can set custom hotkeys for these commands by going to `Settings > Hotkeys` and searching for "Obsidian Smart Composer". (Note: Hotkeys are unset by default)

| Command | Description | Preferred Hotkey |
| --------------------- | ------------------------------------------ | ---------------- |
| Open Chat View | Opens the AI chat interface | Cmd+Shift+L |
| Add Selection to Chat | Adds the selected text to the current chat | Cmd+L |

| Open Chat View | Opens the AI chat interface | Cmd+Shift+L |
| Add Selection to Chat | Adds the selected text to the current chat | Cmd+L |

## Roadmap

Expand All @@ -83,4 +75,4 @@ Obsidian Smart Composer adds a few commands to work with AI. You can set custom

## Contribution

All kinds of contributions are welcome, including bug reports, bug fixes, improvements to documentation, and general enhancements. If you have an idea for a major feature, please create an issue to discuss its feasibility and the best implementation approach.
All kinds of contributions are welcome, including bug reports, bug fixes, improvements to documentation, and general enhancements. If you have an idea for a major feature, please create an issue to discuss its feasibility and the best implementation approach.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion src/components/Chat.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,6 @@ const Chat = forwardRef<ChatRef, ChatProps>((props, ref) => {
</button>
<ChatListDropdown
chatList={chatList}
currentConversationId={currentConversationId}
onSelectConversation={(conversationId) =>
void handleLoadConversation(conversationId)
}
Expand Down
2 changes: 0 additions & 2 deletions src/components/ChatListDropdown.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@ import { ChatConversationMeta } from '../types/chat'

export function ChatListDropdown({
chatList,
currentConversationId,
onSelectConversation,
onDeleteConversation,
className,
children,
}: {
chatList: ChatConversationMeta[]
currentConversationId: string | null
onSelectConversation: (conversationId: string) => void
onDeleteConversation: (conversationId: string) => void
className?: string
Expand Down
4 changes: 2 additions & 2 deletions src/constants.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { SmartCopilotSettings } from './types/settings'

export const CHAT_VIEW_TYPE = 'chat-view'
export const APPLY_VIEW_TYPE = 'apply-view'
export const CHAT_VIEW_TYPE = 'smtcmp-chat-view'
export const APPLY_VIEW_TYPE = 'smtcmp-apply-view'

export const DEFAULT_SETTINGS: SmartCopilotSettings = {
openAIApiKey: '',
Expand Down

0 comments on commit 986468a

Please sign in to comment.