Merge pull request #313 from Checkmk/devel

Release 0.21.0

Author: robin-checkmk

.github/ISSUE_TEMPLATE/bug_report.md

@@ -3,11 +3,11 @@ name: Bug report
 about: Create a report to help us improve
 title: "[BUG]"
 labels: bug
-assignees: robin-tribe29
+assignees: robin-checkmk
 
 ---
 
-Verify first that your issue is not already reported [here](https://github.com/tribe29/ansible-collection-tribe29.checkmk/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
+Verify first that your issue is not already reported [here](https://github.com/Checkmk/ansible-collection-tribe29.checkmk/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
 Where possible also test if the latest release and main branch are affected too.
 Complete all sections as described!
 
@@ -25,8 +25,8 @@ $ ansible --version
 
 ```
 
-**Checkmk Version**
-<!-- Paste the version string, that can be found in the 'Help' menu. -->
+**Checkmk Version and Edition**
+<!-- Paste the version string, that can be found in the 'Help' menu. Please make sure to include the edition!-->
 ```console
 e.g. 2.X.YpZ (CRE)
 ```
@@ -37,8 +37,6 @@ e.g. 2.X.YpZ (CRE)
 $ ansible-galaxy collection list
 
 ```
-**Environment**
-<!-- Provide all relevant information below, e.g. control node OS versions, Python version, etc. -->
 
 **To Reproduce**
 Steps to reproduce the behavior:
@@ -53,8 +51,11 @@ Steps to reproduce the behavior:
 **Actual behavior**
 <!-- A clear and concise description of what actually happens. -->
 
-**Screenshots**
-<!-- If applicable, add screenshots to help explain your problem. -->
+**Minimum reproduction example**
+<!-- If you can, please provide a minimum example of your configuration. This really helps us quickly understand the situation. -->
+```yaml
+
+```
 
 **Additional context**
-<!-- Add any other context about the problem here. -->
+<!-- Add any other context, e.g. OS information about control and managed node, screenshots or background information about the problem. -->

.github/ISSUE_TEMPLATE/feedback.md

@@ -7,7 +7,7 @@ assignees: robin-tribe29
 
 ---
 
-Please verify first that your feedback is not already reported [here](https://github.com/tribe29/ansible-collection-tribe29.checkmk/issues?q=is%3Aissue+sort%3Aupdated-desc).
+Please verify first that your feedback is not already reported [here](https://github.com/Checkmk/ansible-collection-tribe29.checkmk/issues?q=is%3Aissue+sort%3Aupdated-desc).
 If possible and useful provide additional information below. This is optional however.
 
 **Provide your feedback**

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,9 @@
-<!--- Please provide a general summary of your changes in the title above -->
+<!--- Please provide a brief summary of your changes as a title in the textbox above -->
 
 <!---
-Please use the devel branch as the merge target!
+Please use the devel branch as the merge target (see dropdown above)!
 We use that branch as a staging area, to make sure the main branch
-stays as stable as possible, if people are using the branch directly.
+stays as stable as possible, in case people are using it to install the collection directly.
  -->
 
 ## Pull request type
@@ -14,15 +14,15 @@ Please check the type of change your PR introduces:
 - [ ] Bugfix
 - [ ] Feature
 - [ ] Code style update (formatting, renaming)
-- [ ] Refactoring (no functional changes, no api changes)
+- [ ] Refactoring (no functional changes, no API changes)
 - [ ] Build related changes
 - [ ] Documentation content changes
 - [ ] Other (please describe):
 
 ## What is the current behavior?
 <!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
 
-Issue Number: `e.g. #1`
+Issue Number: `e.g. #1` <!-- Delete this, if it does not apply. -->
 
 ## What is the new behavior?
 <!-- Please describe the behavior or changes that are being added by this PR. -->
@@ -32,4 +32,4 @@ Issue Number: `e.g. #1`
 -
 
 ## Other information
-<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
+<!-- Any other information that is important to this PR, e.g screenshots of how the component looks before and after the change. -->

.github/workflows/cla.yml

@@ -0,0 +1,46 @@
+name: 'CLA Assistant'
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened, closed, synchronize]
+
+# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
+permissions:
+  actions: write
+  contents: write
+  pull-requests: write
+  statuses: write
+
+jobs:
+  CLAAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'CLA Assistant'
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA or my organization already has a signed CLA.') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # the below token should have repo scope and must be manually added by you in the repository's secret
+          # This token is required only if you have configured to store the signatures in a remote repository/organization
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_CLA }}
+        with:
+          path-to-signatures: 'signatures/version1/cla.json'
+          path-to-document: 'https://github.com/tribe29/checkmk/blob/master/doc/cla/cla.md' # e.g. a CLA or a DCO document
+          # branch should not be protected
+          branch: 'main'
+          allowlist: bot* # comma separated list of users who are allowed to submit without a CLA bot approval
+          remote-organization-name: 'Checkmk'
+          remote-repository-name: 'cla'
+          custom-pr-sign-comment: 'I have read the CLA Document and I hereby sign the CLA or my organization already has a signed CLA.'
+
+          # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken
+          #remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository)
+          #create-file-commit-message: 'For example: Creating file for storing CLA Signatures'
+          #signed-commit-message: 'For example: $contributorName has signed the CLA in $owner/$repo#$pullRequestNo'
+          #custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign'
+          #custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
+          #custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
+          #lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
+          #use-dco-flag: true - If you are using DCO instead of CLA
+          

.github/workflows/molecule-role-agent.yaml

@@ -0,0 +1,66 @@
+# https://github.com/ansible-collections/collection_template/blob/main/.github/workflows/ansible-test.yml
+# README FIRST
+# 1. replace "NAMESPACE" and "COLLECTION_NAME" with the correct name in the env section (e.g. with 'community' and 'mycollection')
+# 2. If you don't have unit tests remove that section
+# 3. If your collection depends on other collections ensure they are installed, see "Install collection dependencies"
+# If you need help please ask in #ansible-community on the Libera.chat IRC network
+
+name: Molecule Tests for Agent Role
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+      - devel
+    paths:
+      - 'roles/agent/**'
+  push:
+    branches:
+      - main
+      - devel
+    paths:
+      - 'roles/agent/**'
+
+env:
+  NAMESPACE: tribe29
+  COLLECTION_NAME: checkmk 
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    name: Checkmk ${{ matrix.checkmk }} + py${{ matrix.python }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python:
+          - '3.8'
+          - '3.9'
+          - '3.10'
+          - '3.11'
+        checkmk:
+          - '2.0.0'
+          - '2.1.0'
+          - '2.2.0'
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+        with:
+          path: ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install -r requirements.txt
+        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+
+      - name: Test with molecule
+        run: |
+          cd roles/agent/
+          molecule test -s ${{ matrix.checkmk }}
+        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}

.github/workflows/release.yaml

@@ -24,7 +24,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.11'
 
       - name: Install Dependencies
         run: |
@@ -41,7 +41,7 @@ jobs:
           cp $files build/src
           cp -rf $directories build/src
         env:
-          files: "CHANGELOG.rst LICENSE README.md ansible.cfg galaxy.yml"
+          files: "ansible.cfg CHANGELOG.rst galaxy.yml LICENSE README.md"
           directories: "changelogs docs meta playbooks plugins roles"
 
       - name: Build Ansible Collection
@@ -90,34 +90,22 @@ jobs:
       - name: Build Ansible Collection
         run: ansible-galaxy collection build build/src --force
 
-      - name: Create Release
+      - name: Create Release and upload Assets
         id: create-release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: softprops/action-gh-release@v1
         with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          draft: true
+          prerelease: true
+          name: v${{ steps.current_version.outputs.version }}
           tag_name: v${{ steps.current_version.outputs.version }}
-          release_name: v${{ steps.current_version.outputs.version }}
+          files: tribe29-checkmk-${{ steps.current_version.outputs.version }}.tar.gz
           body: |
             # Ansible Collection: tribe29.checkmk
 
-            For information about this collection and how to install it, refer to the [README](https://github.com/tribe29/ansible-collection-tribe29.checkmk/blob/main/README.md).
+            For information about this collection and how to install it, refer to the [README](https://github.com/Checkmk/ansible-collection-tribe29.checkmk/blob/main/README.md).
             
-            For a detailed changelog, refer to the [CHANGELOG](https://github.com/tribe29/ansible-collection-tribe29.checkmk/blob/main/CHANGELOG.rst).
-            ```
-          draft: false
-          prerelease: false
-
-      - name: Upload Release Asset
-        id: upload-release-asset
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create-release.outputs.upload_url }}
-          asset_path: tribe29-checkmk-${{ steps.current_version.outputs.version }}.tar.gz
-          asset_name: tribe29-checkmk-${{ steps.current_version.outputs.version }}.tar.gz
-          asset_content_type: application/tar+gzip
+            For a detailed changelog, refer to the [CHANGELOG](https://github.com/Checkmk/ansible-collection-tribe29.checkmk/blob/main/CHANGELOG.rst).
 
       - name: Publish Ansible Collection to the Galaxy
         run: ansible-galaxy collection publish tribe29-checkmk-${{ steps.current_version.outputs.version }}.tar.gz --api-key ${{ secrets.GALAXY_API_KEY }}

CONTRIBUTING.md

@@ -24,7 +24,7 @@ There are several ways in which you can contribute:
 
 1. Submit an [issue](#Submitting-Issues).
 2. Create a [pull request](#Pull-Requests).
-3. Pick an [issue, which needs help](https://github.com/tribe29/ansible-collection-tribe29.checkmk/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
+3. Pick an [issue, which needs help](https://github.com/Checkmk/ansible-collection-tribe29.checkmk/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
 
 Everything helps, really!
 We do test everything to the best of our abilities, but nothing beats real world
@@ -33,17 +33,18 @@ the functionality, [pull requests](#Pull-Requests) are appreciated.
 
 ### Submitting Issues
 
-If you encounter any bugs or have ideas for improvements feel free to open an [issue](https://github.com/tribe29/ansible-collection-tribe29.checkmk/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) or even better a [pull request](#Pull-Requests).
+If you encounter any bugs or have ideas for improvements feel free to open an [issue](https://github.com/Checkmk/ansible-collection-tribe29.checkmk/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) or even better a [pull request](#Pull-Requests).
 Dedicated requirements will be added here as suitable.
 
 ### Pull Requests
 
-Please open a [pull request](https://github.com/tribe29/ansible-collection-tribe29.checkmk/pulls?q=is%3Apr+is%3Aopen)
+Please open a [pull request](https://github.com/Checkmk/ansible-collection-tribe29.checkmk/pulls?q=is%3Apr+is%3Aopen)
 if you have something to contribute.
 On pull request creation, checks will run and tell you,
 if your changes work with the collection. If errors are detected, please try to
 fix them and update your pull request accordingly.
 If you need help, do ask for it.
+After submitting a PR, follow the instructions to sign the [CLA](https://github.com/tribe29/checkmk/blob/master/doc/cla/cla_readme.md) as asked by the bot.
 
 ### Changelog
 
@@ -138,7 +139,7 @@ Before running the action `Release Collection` against the `main` branch, the
 following needs to be done:
 
 1. Update the collection version in `galaxy.yml` and `requirements.yml`. Look for `version:`.
-2. Check the integration tests for up-to-date Checkmk versions.
+2. Check the integration and molecule tests for up-to-date Checkmk versions.
 3. Check the GitHub Workflows for [EOL Ansible and Python versions and add new releases](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix).
 4. Update the compatibility matrix in `SUPPORT.md` accordingly.
 5. Double check `changelogs/fragments` if all changes have a changelog.