kubeshop / botkube-plugins-template Goto Github PK

Description

We use old syntax without the url property, see:

• https://github.com/kubeshop/botkube-plugins-template/blob/main/.github/workflows/pages-release.yml#L66
• https://github.com/kubeshop/botkube-plugins-template/blob/main/.github/workflows/release.yml#L53

Overview

Add information about setting repo for the GitHub Pages.

• enable GitHub action for GitHub Pages
• update gh-pages environment

Overview

When you create a repository based on this template, you will also get unwanted files. Unfortunately, there is no official way to ignore them, see: https://github.com/orgs/community/discussions/22183

However, one user posted an interesting workaround, about adding a dedicated GitHub action to set up created repository, see: https://github.com/orgs/community/discussions/22183#discussioncomment-4585507

We can approach that in the same way. Additionally, we should add the following note to make sure that in case of failed action, the user will still know what to update:

Update the following files:

• CONTRIBUTING.md
• CODE_OF_CONDUCT.md
• LICENSE
• README.md
• SECURITY.md
• CODEOWNERS

Acceptance Criteria

• GitHub action that set up created repository
  • mostly removing unwanted files, and replacing Kubeshop e.g. in license file.