diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index d354ef8..0000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1,4 +0,0 @@ -# Botkube maintainers (email: dev-team@botkube.io) -# Maintainers are listed alphabetically - -* @kubeshop/botkube-dev diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 00e2252..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Bug -about: Report a bug in the project -labels: bug ---- - - - -## Description - - - -## Expected behavior - - - -## Actual behavior - - - -## Steps to reproduce - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 4139fd1..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Suggest how we can improve -labels: enhancement ---- - - - -## Overview - - - -## Acceptance Criteria - - - -## Reason - - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8a3b780..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,17 +0,0 @@ - - -## Description - -Changes proposed in this pull request: - -- ... - -## Related issue(s) - - diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a81e82c..088000b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,9 +1,9 @@ name: Deploy Botkube plugins on GitHub Release on: - push: - tags: - - '*' + release: + types: + - published jobs: release: @@ -61,7 +61,7 @@ jobs: env: GH_TOKEN: ${{ github.token }} run: | - gh release create "${GITHUB_REF#refs/tags/}" \ + gh release edit "${GITHUB_REF#refs/tags/}" \ --notes-file release.md \ ./dist/executor_* \ ./plugins-index.yaml diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 0758dad..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at [**frontdesk@kubeshop.io**](mailto:frontdesk@kubeshop.io). All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 97a315b..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,55 +0,0 @@ -# How to contribute - -We'd love your help! - -This project is [MIT Licensed](LICENSE) and accepts contributions via GitHub pull requests. This document outlines conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contributions accepted. - -### Prerequisite - -- [Go](https://go.dev), at least 1.18 -- `make` - -#### Develop Botkube plugins - -The example plugins in this repository were developed based on the official guides for the [executor](https://docs.botkube.io/plugin/custom-executor) and [source](https://docs.botkube.io/plugin/custom-source) plugins. - -To test them locally, follow the [local testing](https://docs.botkube.io/plugin/local-testing) guide. - -If you update this template repository, make sure that changes are reflected in the official [Template GitHub repository](https://docs.botkube.io/plugin/template-gh-repo) documentation. - -## Making A Change - -- Before making any significant changes, please [open an issue](https://github.com/kubeshop/botkube-plugins-template/issues). Discussing your proposed changes ahead of time will make the contribution process smooth for everyone. - -- Once we've discussed your changes, and you've got your code ready, make sure that the build steps mentioned above pass. Open your pull request against the [`main`](https://github.com/kubeshop/botkube-plugins-template/tree/main) branch. - - To learn how to do it, follow the **Contribute** section in the [Git workflow guide](https://github.com/kubeshop/botkube/tree/main/git-workflow.md). - -- To avoid build failures in CI, install [`golangci-lint`](https://golangci-lint.run/usage/install/) and run: - - ```sh - # From project root directory - make fix-lint-issues - ``` - This will run the `golangci-lint` tool to lint the Go code. - -### Create a Pull Request - -- Make sure your pull request has [good commit messages](https://chris.beams.io/posts/git-commit/): - - Separate subject from body with a blank line - - Limit the subject line to 50 characters - - Capitalize the subject line - - Do not end the subject line with a period - - Use the imperative mood in the subject line - - Wrap the body at 72 characters - - Use the body to explain _what_ and _why_ instead of _how_ - -- Try to squash unimportant commits and rebase your changes on to the `main` branch, this will make sure we have clean log of changes. - -## Support Channels - -Join the Botkube-related discussion on Slack! - -Create your Slack account on [Botkube](https://join.botkube.io) workspace. - -To report bug or feature, use [GitHub issues](https://github.com/kubeshop/botkube-plugins-template/issues/new/choose). diff --git a/README.md b/README.md index 54d30e3..d7b90e0 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ # Botkube Plugins -This repository shows the example Botkube [source](https://docs.botkube.io/architecture/#source) and [executor](https://docs.botkube.io/architecture/#executor) plugins. +This repository containsBotkube plugins. It is intended as a template repository to start developing Botkube plugins in Go. Repository contains: -- The [`echo`](cmd/echo/main.go) executor that sends back the command that was specified. -- The [`ticker`](cmd/ticker/main.go) source that emits an event each time the configured time duration elapses. -- The [`forwarder`](cmd/forwarder/main.go) source that echos the message sent as an incoming webhook request. -- The [`msg`](cmd/msg/main.go) executor that showcases the interactive message capabilities. +- The [`job`](cmd/job/main.go) executor that runs jobs from cronjobs. +- The [`snippet`](cmd/snippet/main.go) executor that sends command result as slack snippet - The release [GitHub Action](https://github.com/features/actions) jobs: - that creates [GitHub release](.github/workflows/release.yml) with plugin binaries and index file each time a new tag is pushed. - See: https://github.com/kubeshop/botkube-plugins-template/releases/latest diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 4c51226..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,16 +0,0 @@ -# Security policy - -## Reporting a vulnerability - -**Please do not report security vulnerabilities through public GitHub issues.** - -To report security vulnerabilities in Botkube project, please email [**frontdesk@kubeshop.io**](mailto:frontdesk@kubeshop.io) with a detailed description of the issue. If the issue is confirmed, we will release a patch as soon as possible depending on complexity. - -Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: - -- Type of issue. For example, buffer overflow, SQL injection, cross-site scripting, etc. -- The location of the affected source code. Repository name with tag/branch/commit or direct URL. -- Step-by-step instructions to reproduce the issue. -- Impact of the issue, including how an attacker might exploit the issue. - -This information will help us triage your report more quickly. diff --git a/helm/repositories.lock b/helm/repositories.lock deleted file mode 100644 index e69de29..0000000 diff --git a/helm/repositories.yaml b/helm/repositories.yaml deleted file mode 100644 index c731d5f..0000000 --- a/helm/repositories.yaml +++ /dev/null @@ -1,12 +0,0 @@ -apiVersion: "" -generated: "0001-01-01T00:00:00Z" -repositories: -- caFile: "" - certFile: "" - insecure_skip_tls_verify: false - keyFile: "" - name: botkube - pass_credentials_all: false - password: "" - url: https://charts.botkube.io - username: ""