add reuseable renovate config (#38)

nolte · Jan 29, 2022 · a6609ce · a6609ce
1 parent 6652da9
commit a6609ce
Show file tree

Hide file tree

Showing 9 changed files with 172 additions and 10 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,45 @@
+---
+name: "\U0001F41B Bug Report"
+about: "If something isn't working as expected \U0001F914."
+title: ''
+labels: bug
+
+---
+
+<!---
+Hi there,
+
+Thank you for opening an issue.
+--->
+
+
+### Used Release
+
+
+### Debug Output
+<!--Please provider a link to a GitHub Gist containing the complete debug output. Please do NOT paste the debug output in the issue; just paste a link to the Gist. And Please check the Debug Output for any Plain Text Credentials.-->
+
+### Panic Output
+<!--If produced a panic, please provide a link to a GitHub Gist containing the output of the `crash.log`.-->
+
+### Expected Behavior
+What should have happened?
+
+### Actual Behavior
+What actually happened?
+
+### Steps to Reproduce
+<!-- Please list the steps required to reproduce the issue, for example: -->
+
+### Important Factoids
+<!-- Are there anything atypical about your accounts that we should know? For example: Running in EC2 Classic? Custom version of OpenStack? Tight ACLs?-->
+
+### References
+<!--Are there any other GitHub issues (open or closed) or Pull Requests that should be linked here? For example:
+- GH-1234
+-->
+
+### Community Note
+<!--- Please keep this note for the community --->
+* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
+* If you are interested in working on this issue or have submitted a pull request, please leave a comment
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,37 @@
+---
+name: "\U0001F680 Feature Request"
+about: "I have a suggestion (and might want to implement myself \U0001F642)!"
+title: ''
+labels: enhancement
+
+---
+
+
+### Description
+
+<!--- Please leave a helpful description of the feature request here. --->
+
+### Potential Configuration
+
+<!--- Information about code formatting: https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code --->
+
+```hcl
+# Copy-paste your configurations here.
+```
+
+### References
+
+<!---
+Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
+
+Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor blog posts or documentation?
+--->
+
+<!--- Please keep this note for the community --->
+
+### Community Note
+
+* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
+* If you are interested in working on this issue or have submitted a pull request, please leave a comment
+
+<!--- Thank you for keeping this note for the community --->
diff --git a/.tool-versions b/.tool-versions
@@ -1 +1,3 @@
+act 0.2.25
 python 3.8.5
+task 3.10.0
diff --git a/README.md b/README.md
@@ -1,19 +1,26 @@
 # Plumbing
 
+[![Github Project Stars](https://img.shields.io/github/stars/nolte/gh-plumbing.svg?label=Stars&style=social)](https://github.com/nolte/gh-plumbing) [![Github Issue Tracking](https://img.shields.io/github/issues-raw/nolte/gh-plumbing.svg)](https://github.com/nolte/gh-plumbing) [![Github LatestRelease](https://img.shields.io/github/release/nolte/gh-plumbing.svg)](https://github.com/nolte/gh-plumbing) [![.github/workflows/build-static-tests.yaml](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml) [![.github/workflows/release-cd-deliver-docs.yml](https://github.com/nolte/gh-plumbing/actions/workflows/release-cd-deliver-docs.yml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/release-cd-deliver-docs.yml)
+
+---
+
 <!--intro-start-->
 Used for deduplicate the CI/CD Boilerplate-Code. Like [Workflow](https://docs.github.com/en/actions) and [Github App](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps) configurations.
 <!--intro-end-->
 
 ## Workflows
 
 <!--td-workflows-start-->
-| Workflow                            | description                                                                                                                                                  |
-|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| ```reuseable-mkdocs.yaml```         | Publish a [mkdocs](https://www.mkdocs.org/) based Documentation as [Github Page](https://pages.github.com/).                                                 |
-| ```reuseable-pre-commit.yaml```     | call [pre-commit](https://pre-commit.com/) for executing a set of Static Tests.                                                                              |
-| ```reuseable-release-drafter.yml``` | Will be use [release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) for updating the current "Draft" Release with a Changelog. |
-| ```reuseable-trivy.yaml```          | Scan the GitRepo by using [aquasecurity/trivy-action](https://github.com/aquasecurity/trivy-action).                                                         |
-| ```reuseable-automerge.yaml```      | Using [pascalgn/automerge-action](https://github.com/pascalgn/automerge-action) for better Merge Request handling.                                           |
+| Workflow                                      | description                                                                                                                                                       |
+|-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ```reuseable-automerge.yaml```                | Using [pascalgn/automerge-action](https://github.com/pascalgn/automerge-action) for better Merge Request handling.                                                |
+| ```reuseable-mkdocs.yaml```                   | Publish a [mkdocs](https://www.mkdocs.org/) based Documentation as [Github Page](https://pages.github.com/).                                                      |
+| ```reuseable-pre-commit.yaml```               | Call [pre-commit](https://pre-commit.com/) for a minimal static tests set, like liter etc.                                                                        |
+| ```reuseable-release-cd-refresh-master.yml``` | Refresh the current master branch, with the Revision from the Latest published Release, so the master/main branch will be present the `latest` Released version.  |
+| ```reuseable-release-drafter.yml```           | Will be use [release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) for updating the current "Draft" Release with a Changelog.      |
+| ```reuseable-sphinx.yaml```                   | Build and Publish a [Sphinx](https://www.sphinx-doc.org/en/master) Documentation as [Github Page](https://pages.github.com/).                                     |
+| ```reuseable-stale.yaml```                    | Mark old or inactive issues and close then, used [actions/stale](https://github.com/actions/stale) for this work.                                                 |
+| ```reuseable-trivy.yaml```                    | Scan the GitRepo by using [aquasecurity/trivy-action](https://github.com/aquasecurity/trivy-action).                                                              |
 <!--td-workflows-end-->
 
 ## Probot Config
@@ -27,7 +34,7 @@ For Using in other Github Projects, having a reuseable set of Probot Config Repo
 | probot                                                            | git                                                                         | description                                                                                                         |
 |-------------------------------------------------------------------|-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
 | [boring-cyborg](https://probot.github.io/apps/boring-cyborg/)     | [kaxil/boring-cyborg](https://github.com/kaxil/boring-cyborg)               | Different util actions like, automatically label Pull Request                                                       |
-| [release-drafter](https://probot.github.io/apps/release-drafter/) | [toolmantim/release-drafter](https://github.com/toolmantim/release-drafter) | Creates a Human Readable Release Change Log.                                                                        |
+| [release-drafter](https://probot.github.io/apps/release-drafter/) | [toolmantim/release-drafter](https://github.com/toolmantim/release-drafter) | Creates a Human Readable Release Change Log (**(deprecated)**, please use the Workflow Implementation).             |
 | [renovate](https://github.com/apps/renovate)                      |                                                                             | Using [renovate](https://www.whitesourcesoftware.com/free-developer-tools/renovate/) for keep dependencies in sync. |
 | [settings](https://probot.github.io/apps/settings/)               | [probot/settings](https://github.com/probot/settings)                       | Configure Github Projects by Source.                                                                                |
 <!--td-probot-apps-end-->
@@ -39,10 +46,25 @@ For More Inforation take a look to the GH Page, [gh-plumbing](http://nolte.githu
 <!--development-intro-start-->
 We use the [asdf](https://asdf-vm.com/) Packagemanager.
 
-
 ```sh
 asdf install
+```
+
+### Worflows
+
+For local testing you can use [nektos/act](https://github.com/nektos/act), run the GitHub Actions locally.
+
+```sh
+act --job=static
+```
+
+will be start the [![.github/workflows/build-static-tests.yaml](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml) at your local system.
 
+**For the Moment blocked by [#826](https://github.com/nektos/act/issues/826)**.
+
+### Documentation
+
+```sh
 virtualenv ~/.vens/development
 
 source ~/.vens/development/bin/activate
@@ -54,6 +76,18 @@ mkdocs serve -a localhost:8001
 Open [localhost:8001](http://localhost:8001/) for take a look to the lastest documentation, created with [mkdocs](https://www.mkdocs.org/).
 <!--development-intro-end-->
 
+### Task
+
+We use [go-task/task](https://github.com/go-task/task) as alias tooling.
+
+```sh
+task -l  
+
+task: Available tasks for this project:
+* mkdocs:       Start the Mkdocs, for development
+* pre-commit:   Start Precommit
+```
+
 ## Links
 
 * [nolte/cookiecutter-gh-project](https://github.com/nolte/cookiecutter-gh-project) for templating.
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -0,0 +1,24 @@
+# https://taskfile.dev
+
+version: '3'
+
+vars:
+  PYTHON_VENVS_BASEDIR: ~/.vens/
+
+includes:
+  py-dev: ./taskfiles/py-venv-dev.yaml
+
+tasks:
+  pre-commit:
+    desc: Start Precommit
+    deps: ["py-dev:venv-usage"]
+    cmds:
+      - pre-commit run -a
+    silent: true
+
+  mkdocs:
+    desc: Start the Mkdocs, for development
+    deps: ["py-dev:venv-usage"]
+    cmds:
+      - mkdocs serve -a localhost:8001
+    silent: true
diff --git a/renovate-configs/common.json b/renovate-configs/common.json
@@ -0,0 +1,8 @@
+{
+  "extends": [
+    "config:base",
+    ":dependencyDashboard",
+    ":enablePreCommit"
+  ],
+  "labels": ["chore","dependencies"]
+}
diff --git a/renovate.json b/renovate.json
@@ -1,6 +1,6 @@
 {
   "extends": [
-    "config:base"
+    "github>nolte/gh-plumbing/renovate-configs:common"
   ],
   "pip_requirements": {
     "fileMatch": ["requirements.*.txt"]

diff --git a/taskfiles/py-venv-dev.yaml b/taskfiles/py-venv-dev.yaml
@@ -0,0 +1,11 @@
+# https://taskfile.dev
+
+version: '3'
+
+vars:
+  PYTHON_VENV_DIR: "{{.PYTHON_VENVS_BASEDIR}}/development"
+
+tasks:
+  venv-usage:
+    cmds:
+      - source {{.PYTHON_VENV_DIR}}/bin/activate