Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/botcity-dev/botcity-action-bots
Deploy, update and release action to Bots in BotCity.
https://github.com/botcity-dev/botcity-action-bots
Last synced: about 1 month ago
JSON representation
Deploy, update and release action to Bots in BotCity.
- Host: GitHub
- URL: https://github.com/botcity-dev/botcity-action-bots
- Owner: botcity-dev
- License: apache-2.0
- Created: 2023-04-26T07:05:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T16:32:18.000Z (about 2 months ago)
- Last Synced: 2024-11-17T20:51:42.072Z (about 1 month ago)
- Language: Python
- Size: 54.7 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
BotCity Actions - Bots
## 📚 About
This action makes automatic updates, deploys and releases to maestro, without the need for manual implementations.
It is possible to push an update to a specific branch or always upload a new version when a release is released in
the project, it gives creativity and necessity.
## 💻 Usage
```yaml
name: Botcity Action
on: push
jobs:
BotCity:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
with:
fetch-depth: 0
- name: BotCity Action
uses: botcity-dev/[email protected]
with:
update: true
deploy: false
release: false
version: 'v1.0'
botId: 'botcityAction'
technology: 'python'
botPath: './bot.zip'
env:
LOGIN: ${{ secrets.LOGIN }}
SERVER: ${{ secrets.SERVER }}
KEY: ${{ secrets.KEY }}
```
### 🔣 Inputs
| Input | Description | Default |
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|
| `technology` | Technology used in the Bot. (Python, Java, Javascript, Typescript or Command. | **Required** |
| `botPath` | Compressed file path. (zip or tar.gz) | **Required** |
| `update` | Run update in Maestro. | `false` |
| `deploy` | Execute deploy in Maestro. | `false` |
| `release` | Release version to bot in Maestro | `false` |
| `version` | Version of the action to run. If `version` is not set, the latest version is used in update. It is necessary to pass the version when performing deploy and release. | None |
| `repositoryLabel` | This is the repository used at BotCity Orchestrator. Only use in Deploy. | DEFAULT |
## ⛑ Support
### 📢 Join the community
If you have questions or comments in general about the plugin, we want to know.
You can choose between the channels the one that best fit you:
- [Forum BotCity Community]() (Public)
- [Slack BotCity Community]() (Public)
## Contributing
### Bug Reports & Feature Requests
Please use the issue tracker to report any bugs or file feature requests.
Developing
### Local Development
Ready to contribute with code submissions and pull requests (PRs)? Here's how to set up BotCity action for local development.
1. Fork the repo
2. Clone the fork botcity-action repo locally
```shell
git clone [email protected]:botcity-dev/botcity-action.git
```
3. Create a branch for local development:
```shell
git checkout -b
```
4. Run command in source:
```shell
make dev
```
5. Verify changes locally run tests and linters:
```shell
make test
make format-code
make lint
```
6. Now you can make your changes locally.
```shell
git add .
git commit -m "Description of the changes goes here"
git push --set-upstream origin
```
7. It is only necessary to follow the template to create the pull request.
## Code of Conduct
To learn more about the code of conduct, access the following [documentation]().