Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/norio-nomura/swift_discord_bot
Swift Compiler Discord Bot
https://github.com/norio-nomura/swift_discord_bot
deno discord discord-bot docker hacktoberfest heroku swift typescript
Last synced: about 2 months ago
JSON representation
Swift Compiler Discord Bot
- Host: GitHub
- URL: https://github.com/norio-nomura/swift_discord_bot
- Owner: norio-nomura
- License: mit
- Created: 2021-10-02T11:52:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T12:45:03.000Z (8 months ago)
- Last Synced: 2024-05-01T22:43:11.548Z (8 months ago)
- Topics: deno, discord, discord-bot, docker, hacktoberfest, heroku, swift, typescript
- Language: Dockerfile
- Homepage:
- Size: 262 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Swift Compiler Discord Bot
Written in [Deno](https://deno.land) and deployed with Docker.
This is a generalized version of [SwiftCompilerDiscordappBot](https://github.com/norio-nomura/SwiftCompilerDiscordappBot) that can be used with various CLIs by configuration.
## How to use
1. Set Up Bot Account
[Creating a discord bot & getting a token](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)
Required Permissions:
- `CHANGE_NICKNAME` for update nickname
- `READ_MESSAGE_HISTORY` and `VIEW_CHANNEL` for update replies on updating
request from user
2. Invite Bot to Your Guild
Open following URL with changing `` to your bot's Client ID:
`https://discord.com/api/oauth2/authorize?client_id=&scope=bot&permissions=67175424`
3. Run bot on local host using `docker compose`
```terminal.sh-session
export DISCORD_TOKEN="" # discord token
export GITHUB_TOKEN="" # github token
docker compose up
```
4. Send mention to Bot
- The bot will use the first code block as its standard input.
- The bot will treat the mentioned lines as arguments for CLI command lines.
- The bot will run the CLI for each command line and return them in replies.
- When you edit/delete a mention, the bot will also edit/delete its replies.
- The bot will reply in DM channel without mentions.
## Configuration
### Build time configuration
#### Using Official Docker Image
| Variable Name | Description | default |
| -------------- | ------------------------------------------ | --------------------------- |
| `DOCKER_IMAGE` | Docker image that provides swift on ubuntu | swift:jammy |
#### Using swift-DEVELOPMENT-SNAPSHOTS-* tarball
| Variable Name | Description | default |
| --------------- | ----------------------------------------- | -------------------------------------- |
| `DOCKER_FILE` | Use `Dockerfile.nightly` for this feature | Dockerfile |
| `SWIFT_WEBROOT` | Webroot getting Swift toolcahin tar ball | https://download.swift.org/development |
### Environment variables for run time configurations
| Variable Name | Description | default |
| -------------------------- | -------------------------------------- | ------------------ |
| `DISCORD_TOKEN` | Discord Bot's token | |
| `DISCORD_NICKNAME` | Discord Nickname | Swift Version |
| `DISCORD_PLAYING` | status for "Playing" | Tag in apple/swift |
| `ENV_COMMAND` | Env command launching Timeout command | `/usr/bin/env` |
| `ENV_ARGS` | arguments for Env command | `-i` |
| ``GITHUB_TOKEN` | GitHub token (permission: public_repo) | |
| `TARGET_CLI` | target CLI | `swift` |
| `TARGET_ARGS_TO_USE_STDIN` | arguments for CLI with input | `-` |
| `TARGET_DEFAULT_ARGS` | arguments for CLI with no arguments | |
| `TIMEOUT_COMMAND` | Timeout command launching target CLI | `timeout` |
| `TIMEOUT_ARGS` | arguments for timeout command | `--signal=KILL 30` |
### Example
#### swift 5.4 compiler bot:
```terminal.sh-session
export DISCORD_TOKEN="" # discord token
export DOCKER_IMAGE=swift:5.4 # docker image
export GITHUB_TOKEN="" # github token
docker compose up
```
## Author
Norio Nomura
## License
CLI Discord Bot is available under the MIT license. See the LICENSE file for
more info.