Skip to content

Commit

Permalink
ci: added "semantic-release" to create automated "alpha" releases
Browse files Browse the repository at this point in the history
  • Loading branch information
TimPietrusky committed Feb 17, 2024
1 parent dbb05a4 commit 76494d0
Show file tree
Hide file tree
Showing 7 changed files with 12,665 additions and 7,597 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/release-windows.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Release - Windows

on:
workflow_dispatch:
push:
branches:
- "alpha"

jobs:
release:
runs-on: windows-latest-l
if: ${{ !contains(github.event.head_commit.message, 'chore(release)') }}
permissions:
contents: write # to be able to publish a GitHub release
issues: write # to be able to comment on released issues
pull-requests: write # to be able to comment on released pull requests

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Setup node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"

- name: Install dependencies
run: npm install

- name: Fix auto-fixable eslint issues
run: npm run eslint -- --fix

- name: Update the ToC in the README.md
run: npx markdown-toc README.md -i

- name: Semantic release
run: npx semantic-release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
53 changes: 53 additions & 0 deletions .releaserc
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
{
"branches": [
"main",
{
"name": "alpha",
"prerelease": true
}
],
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
[
"@semantic-release/npm",
{
"npmPublish": false
}
],
[
"@semantic-release/changelog",
{
"changelogFile": "CHANGELOG.md"
}
],
[
"@semantic-release/exec",
{
"prepareCmd": "npm run build && node ./scripts/update-readme.mjs ${nextRelease.version}"

}
],
[
"@semantic-release/git",
{
"assets": [
"README.md",
"CHANGELOG.md",
"package.json"
],
"message": "chore(release): ${nextRelease.version} \n\n${nextRelease.notes}"
}
],
[
"@semantic-release/github",
{
"assets": [
{
"path": "dist/Captain-Setup*.exe"
}
]
}
]
]
}
82 changes: 50 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
# Captain: Your Local AI Hub (currently in BETA)

Captain simplifies AI on your desktop. It's a free, open-source application that requires no complex setup — just a single .exe file. It provides a variety of AI tools and features a multi-language UI.
Captain simplifies AI on your desktop. It's a free, open-source application that requires no complex
setup — just a single .exe file. It provides a variety of AI tools and features a multi-language UI.

[![Discord](https://img.shields.io/discord/1091306623819059300?color=7289da&label=Discord&logo=discord&logoColor=fff&style=for-the-badge)](https://discord.com/invite/m3TBB9XEkb)

Captain currently supports English, German, Spanish, French, Italian, Japanese, Dutch, Polish, Portuguese, Russian, and Chinese.

Captain currently supports English, German, Spanish, French, Italian, Japanese, Dutch, Polish,
Portuguese, Russian, and Chinese.

<p align="center">
<img src="./docs/logo.png" alt="Download Captain" width="300">
</p>

<!-- releases -->
<p align="center">
<a href="https://github.com/blib-la/captain/releases/download/v1.0.0-beta.9/Captain.Setup.1.0.0-beta.9.exe">
<img src="./docs/download.svg" alt="Download Captain" width="300">
</a>
</p>
<!-- releasesstop -->

## Coming soon: Live Painting with AI, on your Computer

Expand All @@ -25,30 +28,35 @@ Captain currently supports English, German, Spanish, French, Italian, Japanese,

https://github.com/blib-la/captain/assets/1148334/e9f9419e-f6d7-4f35-96a7-667c18b799e2


<!-- toc -->

- [Key Features](#key-features)
- [Planned Features](#planned-features)
- [Getting Started](#getting-started)
* [Installation](#installation)
* [Detailed User Guide](#detailed-user-guide)
- [Important Note: Installation Warning for Unsigned App](#important-note-installation-warning-for-unsigned-app)
- [Community and Support](#community-and-support)
- [Contribute to Captain](#contribute-to-captain)
- [License](#license)
- [Acknowledgments](#acknowledgments)
- [Key Features](#key-features)
- [Planned Features](#planned-features)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Detailed User Guide](#detailed-user-guide)
- [Important Note: Installation Warning for Unsigned App](#important-note-installation-warning-for-unsigned-app)
- [Community and Support](#community-and-support)
- [Contribute to Captain](#contribute-to-captain)
- [License](#license)
- [Acknowledgments](#acknowledgments)

<!-- tocstop -->

## Key Features

- **Versatile AI Tool Integration**: Seamlessly connect with various AI tools and models for diverse functionalities.
- **Local and Online Modes**: Operate fully offline after initial model downloads or connect with online AI services like OpenAI's GPT and RunPod.
- **Self-Contained Application**: Enjoy the simplicity of a single `.exe` file with no need for installing Python dependencies or other software.
- **Open Source and Free**: Accessible AI for everyone, with the full source code available for modification and extension.
- **Dynamic AI Model Marketplace**: Easily download and update Stable Diffusion checkpoints, LoRAs or other models directly through the in-app marketplace.
- **Image Captioning** : Start with state-of-the-art automatic captioning powered by multiple AI methods.
- **Versatile AI Tool Integration**: Seamlessly connect with various AI tools and models for
diverse functionalities.
- **Local and Online Modes**: Operate fully offline after initial model downloads or connect with
online AI services like OpenAI's GPT and RunPod.
- **Self-Contained Application**: Enjoy the simplicity of a single `.exe` file with no need for
installing Python dependencies or other software.
- **Open Source and Free**: Accessible AI for everyone, with the full source code available for
modification and extension.
- **Dynamic AI Model Marketplace**: Easily download and update Stable Diffusion checkpoints, LoRAs
or other models directly through the in-app marketplace.
- **Image Captioning** : Start with state-of-the-art automatic captioning powered by multiple AI
methods.

## Getting Started

Expand All @@ -60,46 +68,56 @@ https://github.com/blib-la/captain/assets/1148334/e9f9419e-f6d7-4f35-96a7-667c18

### Detailed User Guide

For a comprehensive walkthrough of Captain's captioning feature and detailed instructions on how to make the most of Captain, please refer to our dedicated User Guide.
For a comprehensive walkthrough of Captain's captioning feature and detailed instructions on how to
make the most of Captain, please refer to our dedicated User Guide.

[Read the Full Guide](./docs/GUIDE.md)

This guide will assist you in navigating the captioning capabilities of Captain, ensuring you can leverage the power of local AI with confidence and ease.
This guide will assist you in navigating the captioning capabilities of Captain, ensuring you can
leverage the power of local AI with confidence and ease.

## Important Note: Installation Warning for Unsigned App

As Captain is currently an unsigned application, you may encounter a warning during the installation process. This is a standard notification for unsigned apps and does not indicate any security issue with Captain. Since Captain is open source, you can review the source code to ensure its safety.
As Captain is currently an unsigned application, you may encounter a warning during the installation
process. This is a standard notification for unsigned apps and does not indicate any security issue
with Captain. Since Captain is open source, you can review the source code to ensure its safety.

If you receive a warning, please follow these steps to proceed with the installation:

1. **Windows Users**:
- When the warning appears, click on "More info".
- You'll then see the option to "Run anyway". Click it to proceed with the installation.

- When the warning appears, click on "More info".
- You'll then see the option to "Run anyway". Click it to proceed with the installation.

2. **Mac Users** (if applicable in the future):
- Right-click (or Ctrl-click) the downloaded file and select "Open".
- In the warning dialog that appears, click "Open" to proceed.

Rest assured, the integrity and security of Captain are paramount to us. If you have any concerns or questions, please feel free to review our source code or contact us directly.
- Right-click (or Ctrl-click) the downloaded file and select "Open".
- In the warning dialog that appears, click "Open" to proceed.

Enjoy the powerful capabilities of Captain, and thank you for your trust and support!
Rest assured, the integrity and security of Captain are paramount to us. If you have any concerns or
questions, please feel free to review our source code or contact us directly.

Enjoy the powerful capabilities of Captain, and thank you for your trust and support!

## Community and Support

Encounter an issue or have suggestions? Head to our [issue tracker](https://github.com/blib-la/captain/issues) or engage with the community. Your feedback helps Captain sail smoothly!
Encounter an issue or have suggestions? Head to our
[issue tracker](https://github.com/blib-la/captain/issues) or engage with the community. Your
feedback helps Captain sail smoothly!

## Contribute to Captain

Join us on deck! If you're looking to contribute, our [Contribution Guidelines](./.github/CONTRIBUTING.md) will help you get started.
Join us on deck! If you're looking to contribute, our
[Contribution Guidelines](./.github/CONTRIBUTING.md) will help you get started.

## License

Captain is proudly open source, available under the [AGPL 3.0 License](./LICENSE).

## Acknowledgments

Hats off to our contributors, community, and everyone who supports Captain. Together, we're navigating the exciting waters of AI.
Hats off to our contributors, community, and everyone who supports Captain. Together, we're
navigating the exciting waters of AI.

---

Expand Down
1 change: 1 addition & 0 deletions electron-builder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ publish: null
nsis:
oneClick: false
allowToChangeInstallationDirectory: true
artifactName: "${productName}-Setup-${version}.${ext}"
asar: true
asarUnpack:
- "resources/python/**/*"
Expand Down
Loading

0 comments on commit 76494d0

Please sign in to comment.