Skip to content

Commit

Permalink
Set up cd to release vsix file (#3)
Browse files Browse the repository at this point in the history
* chore: remove unnecessary comments

* build: fix extention name to slidaiv

* chore: fix progress message

* build: move menu position

* chore: remove unnecessary lines

* build: add vsce package script

* build: add required dependencies

* build: remove previous added dependencies & fix package command

* docs: write README

* build: add necessary info for this project

* build: add cd step
  • Loading branch information
kaakaa authored Jun 23, 2024
1 parent 85b7f45 commit 42dd82c
Show file tree
Hide file tree
Showing 9 changed files with 1,115 additions and 101 deletions.
8 changes: 8 additions & 0 deletions .github/workflows/ci.yml → .github/workflows/cicd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ on:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
release:
types: [ "created" ]

jobs:
build:
Expand All @@ -21,3 +23,9 @@ jobs:
- run: sudo apt-get install -y xvfb
- run: pnpm install
- run: xvfb-run --auto-servernum pnpm test
- name: Publish
if: success() && startsWith(github.ref, 'refs/tags/')
run: |
pnpm run vscode:package
gh release create "$GITHUB_REF_NAME" --title "$GITHUB_REF_NAME" --notes "Release $GITHUB_REF_NAME" slidaiv-*.vsix
2 changes: 2 additions & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
.vscode/**
.vscode-test/**
e2e/**
out/**
node_modules/**
slidev/**
src/**
.gitignore
.yarnrc
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Change Log

All notable changes to the "demo-webpack" extension will be documented in this file.
All notable changes to the "slidaiv" extension will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

Expand Down
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Yusuke Nemoto

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.
69 changes: 8 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,18 @@
# demo-webpack README
# slidaiv

This is the README for your extension "demo-webpack". After writing up a brief description, we recommend including the following sections.
This is the README for the VS Code extension "slidaiv". This extension leverages AI/LLM to automatically generate content for Slidev presentations, making it easier for users to write a Slidev presentation.

## Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under your extension project workspace:

\!\[feature X\]\(images/feature-x.png\)

> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
## Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
- **Automatic Content Generation**: Generate Slidev content using AI/LLM based on user prompts.
- **Easy Integration**: Seamlessly integrates with VS Code for a smooth workflow.
- **Customizable**: Users can specify their own prompts to guide the content generation process.

## Extension Settings

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

For example:

This extension contributes the following settings:

* `myExtension.enable`: Enable/disable this extension.
* `myExtension.thing`: Set to `blah` to do something.

## Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

## Release Notes

Users appreciate release notes as you update your extension.

### 1.0.0

Initial release of ...

### 1.0.1

Fixed issue #.

### 1.1.0

Added features X, Y, and Z.

---

## Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)

## Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.

## For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
* `slidevContentGenerator.apiKey`: The API key for accessing the AI/LLM service.
* `slidevContentGenerator.baseUrl`: The base URL for the AI/LLM service.
* `slidevContentGenerator.model`: The model used for generating content.

**Enjoy!**
18 changes: 10 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"name": "demo-webpack",
"displayName": "demo-webpack",
"description": "",
"name": "slidaiv",
"displayName": "slidaiv",
"description": "slidaiv extension leverages AI/LLM to automatically generate content for Slidev presentations, making it easier for users to write a Slidev presentation.",
"repository": "https://github.com/kaakaa/slidaiv",
"version": "0.0.1",
"packageManager": "[email protected]",
"engines": {
Expand All @@ -16,8 +17,8 @@
"contributes": {
"commands": [
{
"command": "demo-webpack.helloWorld",
"title": "Hello World"
"command": "slidaiv.generateContents",
"title": "Generate Slidev contents"
}
],
"configuration": {
Expand Down Expand Up @@ -46,16 +47,17 @@
"menus": {
"editor/context": [
{
"command": "demo-webpack.helloWorld",
"command": "slidaiv.generateContents",
"when": "editorLangId == markdown",
"group": "navigation"
"group": "1_modification@99"
}
]
}
},
"scripts": {
"preinstall": "./install-slidev.sh",
"vscode:prepublish": "npm run package",
"vscode:package": "vsce package --no-dependencies",
"compile": "webpack",
"watch": "webpack --watch",
"package": "webpack --mode production --devtool hidden-source-map",
Expand All @@ -82,14 +84,14 @@
"@typescript-eslint/parser": "^7.7.1",
"@vscode/test-cli": "^0.0.9",
"@vscode/test-electron": "^2.3.9",
"@vscode/vsce": "^2.29.0",
"eslint": "^8.57.0",
"ts-loader": "^9.5.1",
"typescript": "^5.4.5",
"webpack": "^5.91.0",
"webpack-cli": "^5.1.4"
},
"dependencies": {
"compile": "^0.0.2",
"js-yaml": "^4.1.0",
"openai": "^4.47.1"
}
Expand Down
Loading

0 comments on commit 42dd82c

Please sign in to comment.