Merge branch 'kapicorp:master' into remove_distutil_copy_tree

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,113 @@
+name: Bug Report
+description: File a bug report
+title: "[bug]: "
+labels: ["bug"]
+body:
+ # information
+ - type: markdown
+ attributes:
+ value: | 
+ Thanks for taking the time to fill out this bug report!
+ *Note:* Please search to see if an issue already exists for the bug you encountered.
+ # bug description
+ - type: textarea
+ id: bug-description
+ attributes:
+ label: Description of the bug
+ description: A clear and concise description of what the bug is.
+ placeholder: Tell us what you see!
+ validations:
+ required: true
+ # steps to reproduce
+ - type: textarea
+ id: steps-to-reproduce
+ attributes:
+ label: Steps to reproduce
+ description: Steps to reproduce the behavior. Also provide parts of your inventory, if it's neccessary.
+ placeholder: Tell us what steps you did to encounter the bug!
+ render: bash
+ value: |
+ 1. 
+ 2. 
+ 3. 
+ 4. 
+ validations:
+ required: true
+ # expected behavior
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: What happened?
+ description: A clear and concise description of what you expected to happen.
+ placeholder: Tell us what you'd expect to happen.
+ validations:
+ required: true
+ # additional context
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional context
+ description: | 
+ Add any other context about the problem here.
+ If applicable, you can add screenshots to help explain your problem.
+ placeholder: Anything that might help us understanding your problem...
+ # section environment
+ - type: markdown
+ attributes:
+ value: |
+ ## Environment
+ # kapitan version
+ - type: dropdown
+ id: version
+ attributes:
+ label: Version (kapitan)
+ description: |
+ Which version of kapitan are you running? 
+ If you are using an older version of kapitan, please try it against the master branch or the latest stable version.
+ options:
+ - v0.31.0 (stable)
+ - master
+ multiple: true
+ validations:
+ required: true
+ # python version
+ - type: dropdown
+ id: python-version
+ attributes:
+ label: Version (kapitan)
+ description: |
+ Which version of python are you using? Kapitan officially supports only version 3.10 and 3.11 
+ If you are using an older version of python, please check if the bug still exists with a newer (supported) version.
+ options:
+ - "3.11"
+ - "3.10" 
+ - I use kapitan directly (pip, docker)
+ multiple: true
+ validations:
+ required: true
+ # python virtual environment
+ - type: checkboxes
+ id: python-venv
+ attributes:
+ label: Python virtual environment
+ description: Are you using pyenv or virtualenv?
+ options:
+ - label: pyenv
+ - label: venv
+ - label: no environment
+ # os information
+ - type: input
+ id: os-information
+ attributes:
+ label: OS information
+ description: Which operation system do you use?
+ placeholder: Type in your operation system...
+ # logs
+ - type: textarea
+ id: logs
+ attributes:
+ label: Relevant log output
+ description: | 
+ Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+ Use the `--verbose` flag to see all the logs.
+ render: bash

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,10 @@
+blank_issues_enabled: false
+contact_links:
+- name: '💬 Open a Discussion'
+ url: https:/kapicorp/kapitan/discussions/new/choose
+ about: |
+ Share your thoughts, ideas, or concerns, and engage in discussions with the community to collaborate and improve the project.
+- name: '💬 Join us on Slack'
+ url: https://kubernetes.slack.com/archives/C981W2HD3
+ about: |
+ Join our Slack channel to connect with our community, ask questions, and stay updated on project developments.

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,29 @@
+name: Documentation Issue
+description: Give us feedback on the documentation
+title: "[docs]: "
+labels: ["documentation"]
+body:
+ # information
+ - type: markdown
+ attributes:
+ value: | 
+ Thanks for taking the time to give us feedback!
+ # feature description
+ - type: textarea
+ id: documentation-issue-description
+ attributes:
+ label: Description of the documentation issue
+ description: |
+ A clear and concise description of what the issue with documentation is. 
+ Please make proposals, how it could be done better.
+ placeholder: Tell us what you want to see in the project!
+ validations:
+ required: true
+ # additional context
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional context
+ description: | 
+ Add any other context about the feature here.
+ placeholder: Anything that might help us understanding your documentation issue...

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,29 @@
+name: Feature Request
+description: Request a new functionality
+title: "[feat]: "
+labels: ["feature"]
+body:
+ # information
+ - type: markdown
+ attributes:
+ value: | 
+ Thanks for taking the time to fill out this feature request!
+ # feature description
+ - type: textarea
+ id: feature-description
+ attributes:
+ label: Description of the feature
+ description: |
+ A clear and concise description of what the feature request is. 
+ Please make proposals, how you would use this feature (syntax).
+ placeholder: Tell us what you want to see in the project!
+ validations:
+ required: true
+ # additional context
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional context
+ description: | 
+ Add any other context about the feature here.
+ placeholder: Anything that might help us understanding your feature request...

.github/dependabot.yml

@@ -10,12 +10,18 @@ updates:
  schedule:
  interval: "weekly"
  commit-message:
- prefix: "PIP dependency update"
+ prefix: "chore: "
  ignore:
  - dependency-name: "google-api-python-client"
  labels:
- - "pip"
  - "dependencies"
  open-pull-requests-limit: 2
  reviewers:
  - "kapicorp/kapicorpdevs"
+ # Maintain dependencies for GitHub Actions
+ - package-ecosystem: "github-actions"
+ directory: "/"
+ schedule:
+ interval: "daily"
+ labels:
+ - "github-actions"

.github/pull_request_template.md

@@ -0,0 +1,10 @@
+Fixes #
+
+## Proposed Changes
+
+*
+
+## Docs and Tests
+
+* [ ] Tests added
+* [ ] Updated documentation

.github/workflows/documentation.yml

@@ -1,35 +1,41 @@
 ---
 name: Build and deploy documentation on merge to master
+
+concurrency:
+ group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+ cancel-in-progress: true
+
 on:
+ pull_request:
+ paths:
+ - 'docs/**'
+ - '.github/worklows/documentation.yml'
+ - 'requirements.docs.txt'
+ - 'Dockerfile.docs'
+ - 'mkdocs.yml'
+ - 'CNAME' 
  push:
  branches:
  - master
+ paths:
+ - 'docs/**'
+ - '.github/worklows/documentation.yml'
+ - 'requirements.docs.txt'
+ - 'Dockerfile.docs'
+ - 'mkdocs.yml'
+ - 'CNAME'
+
 jobs:
- build:
+ docs:
  runs-on: ubuntu-latest
  steps:
  - name: Checkout kapitan recursively
- uses: actions/checkout@master
- with:
- submodules: recursive
- - name: Strip git ref prefix from tag version and store in TAG_VERSION
- run: |
- echo "TAG_VERSION=${GITHUB_REF#refs/*/v}" >> $GITHUB_ENV
- echo "REF_NAME=${GITHUB_REF##*/}" >> $GITHUB_ENV
-
- - name: Strip full version and just keep major part in MAJOR_VERSION VAR
- run: |
- echo "MAJOR_VERSION=${TAG_VERSION:0:4}" >> $GITHUB_ENV
-
- # Printing versions needs to be a separate step,
- # as they aren't set during the previous two steps
- - name: Print Versions
- run: |
- echo ${{ env.TAG_VERSION }}
- echo ${{ env.MAJOR_VERSION }}
- echo ${{ env.REF_NAME }}
-
+ uses: actions/checkout@v4
+ - uses: actions/setup-python@v2
+ - run: pip install --upgrade pip && pip install -r requirements.docs.txt
+ - run: mkdocs build
  - name: Deploy docs
+ if: github.event_name != 'pull_request' && github.ref == github.event.repository.default_branch
  uses: mhausenblas/mkdocs-deploy-gh-pages@master
  env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}