Skip to content

Commit

Permalink
Change activity bar icon and readme for marketplace
Browse files Browse the repository at this point in the history
  • Loading branch information
farisd16 committed Nov 28, 2024
1 parent 93a2e51 commit ee5917a
Show file tree
Hide file tree
Showing 11 changed files with 82 additions and 132 deletions.
53 changes: 53 additions & 0 deletions README.dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# A VSCode Extension for the UML Modeling Editor [Apollon](https://github.com/ls1intum/Apollon)

This is an Visual Studio Code extension for the UML modeling editor Apollon. It enables the developer to model UML diagrams directly within the IDE, save and export diagrams - making it easy to version diagrams with Git as part of the development workflow.

## Installation

Install all dependencies

```
npm run install:all
```

## Development

### Debug extension

First, run the menu webview app

```
npm run start:menu
```

Then, in another terminal tab, run the editor webview app

```
npm run start:editor
```

Finally, in order to debug the extension in VS Code, press `F5`, or press `Ctrl+Shift+P` and type `Debug: Start Debugging`.

### Release a new version

![](.github/media/home_to_release.png)

1. Go to the GitHub `Releases` in the `apollon-vscode` repository
2. Click on `Draft a new release`

![](.github/media/releases_list.png)

3. Choose as a tag the new version number to release (e.g. tag version `v1.5.0` releases the version `1.5.0`)
4. Let the release notes be auto-generated by clicking `Generate release notes`

![](.github/media/create_release.png)

5. An admin now has to review and accept the new release
6. After the release is approved, GitHub will automatically build and upload the artifact as well as publish the new version to the marketplace.

The latest plugin artifact is now available on GitHub and via the VS Code marketplace.

**It might take some time for the latest version to be seen on the marketplace since VS Code still has to review
and approve the changes!**

![](.github/media/release.gif)
52 changes: 1 addition & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,3 @@
# A VSCode Extension for the UML Modeling Editor [Apollon](https://github.com/ls1intum/Apollon)

This is an IDE-integrated Visual Studio Code extension for the UML modeling editor Apollon. It enables the developer to model UML diagrams directly within the IDE, save and export diagrams - making it easy to version diagrams with Git as part of the development workflow.

## Installation

Install all dependencies

```
npm run install:all
```

## Development

### Debug extension

First, run the menu webview app

```
npm run start:menu
```

Then, in another terminal tab, run the editor webview app

```
npm run start:editor
```

Finally, in order to debug the extension in VS Code, press `F5`, or press `Ctrl+Shift+P` and type `Debug: Start Debugging`.

### Release a new version

![](.github/media/home_to_release.png)

1. Go to the GitHub `Releases` in the `apollon-vscode` repository
2. Click on `Draft a new release`

![](.github/media/releases_list.png)

3. Choose as a tag the new version number to release (e.g. tag version `v1.5.0` releases the version `1.5.0`)
4. Let the release notes be auto-generated by clicking `Generate release notes`

![](.github/media/create_release.png)

5. An admin now has to review and accept the new release
6. After the release is approved, GitHub will automatically build and upload the artifact as well as publish the new version to the marketplace.

The latest plugin artifact is now available on GitHub and via the VS Code marketplace.

**It might take some time for the latest version to be seen on the marketplace since VS Code still has to review
and approve the changes!**

![](.github/media/release.gif)
This is an Visual Studio Code extension for the UML modeling editor Apollon. It enables the developer to model UML diagrams directly within the IDE, save and export diagrams - making it easy to version diagrams with Git as part of the development workflow.
38 changes: 0 additions & 38 deletions editor/src/App.css
Original file line number Diff line number Diff line change
@@ -1,38 +0,0 @@
.App {
text-align: center;
}

.App-logo {
height: 40vmin;
pointer-events: none;
}

@media (prefers-reduced-motion: no-preference) {
.App-logo {
animation: App-logo-spin infinite 20s linear;
}
}

.App-header {
background-color: #282c34;
min-height: 100vh;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
font-size: calc(10px + 2vmin);
color: white;
}

.App-link {
color: #61dafb;
}

@keyframes App-logo-spin {
from {
transform: rotate(0deg);
}
to {
transform: rotate(360deg);
}
}
4 changes: 2 additions & 2 deletions editor/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ function App() {
return (
<>
<div className="app-bar">
<VSCodeButton className="mx-3" onClick={saveDiagram}>
<VSCodeButton className="m-3" onClick={saveDiagram}>
Save
</VSCodeButton>
<VSCodeButton className="mx-3" onClick={exportDiagram}>
<VSCodeButton className="m-3" onClick={exportDiagram}>
Export as SVG
</VSCodeButton>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const ApollonContainer = styled.div`
flex-direction: column;
overflow: hidden;
background-color: var(--apollon-background);
min-height: calc(100vh - 3rem);
`;

export const ApollonEditorComponent: React.FC = () => {
Expand Down
2 changes: 1 addition & 1 deletion editor/src/index.css
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ body {
.app-bar {
width: 100%;
background: var(--vscode-activityBar-background);
padding: 1rem 0;
height: 3rem;
display: flex;
justify-content: flex-start;
}
22 changes: 22 additions & 0 deletions media/apollon-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed media/tum-logo.png
Binary file not shown.
38 changes: 0 additions & 38 deletions menu/src/App.css
Original file line number Diff line number Diff line change
@@ -1,38 +0,0 @@
.App {
text-align: center;
}

.App-logo {
height: 40vmin;
pointer-events: none;
}

@media (prefers-reduced-motion: no-preference) {
.App-logo {
animation: App-logo-spin infinite 20s linear;
}
}

.App-header {
background-color: #282c34;
min-height: 100vh;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
font-size: calc(10px + 2vmin);
color: white;
}

.App-link {
color: #61dafb;
}

@keyframes App-logo-spin {
from {
transform: rotate(0deg);
}
to {
transform: rotate(360deg);
}
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
{
"id": "apollon",
"title": "Apollon",
"icon": "media/tum-logo.png"
"icon": "media/apollon-icon.svg"
}
]
},
Expand Down
2 changes: 1 addition & 1 deletion src/menu-provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ export default class MenuProvider implements vscode.WebviewViewProvider {
} else {
this.editorPanel = vscode.window.createWebviewPanel(
"editor",
name,
`${name} (Editor view)`,
vscode.ViewColumn.One,
{
enableScripts: true,
Expand Down

0 comments on commit ee5917a

Please sign in to comment.