Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
nolte committed Dec 18, 2020
0 parents commit 91818b1
Show file tree
Hide file tree
Showing 23 changed files with 359 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
root = true

[*]
insert_final_newline = true
charset = utf-8
trim_trailing_whitespace = true

[{Makefile,go.mod,go.sum,.gitmodules}]
indent_style = tab
indent_size = 8

[*.md]
indent_style = space
indent_size = 4
trim_trailing_whitespace = false

eclint_indent_style = unset

[Dockerfile]
indent_style = space
indent_size = 4
2 changes: 2 additions & 0 deletions .github/boring-cyborg.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
_extends: gh-plumbing:.github/commons-boring-cyborg.yml
13 changes: 13 additions & 0 deletions .github/commons-boring-cyborg.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
labelPRBasedOnFilePath:
cicd:
- .github/workflows/**
project-config:
- .github/settings.yml
chore:
- .github/**
documentations:
- docs/**
- mkdocs.yml
- .github/ISSUE_TEMPLATE/**
- .github/pull_request_template.md
23 changes: 23 additions & 0 deletions .github/commons-release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name-template: v$NEXT_PATCH_VERSION
tag-template: v$NEXT_PATCH_VERSION
branches:
- master
- develop
categories:
- title: 🚀 Features
label: enhancement
- title: 🐛 Bug Fixes
label: bug
- title: 🧰 Maintenance
labels:
- "chore"
- "documentations"
- "project-config"
- "cicd"
- "dependencies"

template: |
## Changes
$CHANGES
100 changes: 100 additions & 0 deletions .github/commons-settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
---
# These settings are synced to GitHub by https://probot.github.io/apps/settings/
repository:

# Either `true` to make the repository private, or `false` to make it public.
private: false

# Either `true` to enable issues for this repository, `false` to disable them.
has_issues: true

# Either `true` to enable projects for this repository, or `false` to disable them.
# If projects are disabled for the organization, passing `true` will cause an API error.
has_projects: true

# Either `true` to enable the wiki for this repository, `false` to disable it.
has_wiki: true

has_pages: true

# Either `true` to enable downloads for this repository, `false` to disable them.
has_downloads: true

# Updates the default branch for this repository.
default_branch: develop

# Either `true` to allow squash-merging pull requests, or `false` to prevent
# squash-merging.
allow_squash_merge: true

# Either `true` to allow merging pull requests with a merge commit, or `false`
# to prevent merging pull requests with merge commits.
allow_merge_commit: true

# Either `true` to allow rebase-merging pull requests, or `false` to prevent
# rebase-merging.
allow_rebase_merge: true

delete_branch_on_merge: true

# Labels: define labels for Issues and Pull Requests
labels:
- name: bug
color: "#CC0000"
description: An issue with the system.

- name: enhancement
color: "#336699"
description: New functionality.

- name: chore
color: "#6e70ef"
description: Maintenance

- name: question
color: "#3ffc8a"
description: User question

- name: documentations
color: "#caa7e8"
description: Update documentation

- name: cicd
color: "#fbca04"
description: ci/cd process functionality.

- name: project-config
color: "#ed979d"
description: Change GitHub project config, keep a extra eye on merge.

- name: breaking-change
color: "#fc415d"
description: Planed braking provider change.

- name: duplicate
color: "#cfd3d7"
description: This issue or pull request already exists.

- name: dependencies
color: "#0366d6"
description: Pull requests that update a dependency file.

- name: wontfix
color: "#ffffff"
description: ""

branches:
- name: master
protection:
required_pull_request_reviews: null
required_status_checks: null
enforce_admins: true
restrictions: null
- name: develop
protection:
required_pull_request_reviews: null
required_status_checks:
strict: true
contexts:
- "Static CI Tests"
restrictions: null
18 changes: 18 additions & 0 deletions .github/commons-stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
# Number of days of inactivity before an issue becomes stale
daysUntilStale: 60
# Number of days of inactivity before a stale issue is closed
daysUntilClose: 7
# Issues with these labels will never be considered stale
exemptLabels:
- pinned
- security
# Label to use when marking an issue as stale
staleLabel: wontfix
# Comment to post when marking an issue as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: false
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
- package-ecosystem: "gomod"
directory: "/"
schedule:
interval: "daily"
2 changes: 2 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
_extends: gh-plumbing:.github/commons-release-drafter.yml
8 changes: 8 additions & 0 deletions .github/settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
_extends: gh-plumbing:.github/commons-settings.yml

repository:
name: gh-plumbing
description: Github Project plumbing
homepage: https://nolte.github.io/gh-plumbing/
topics: github, plumbing
2 changes: 2 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
_extends: gh-plumbing:.github/commons-stale.yml
15 changes: 15 additions & 0 deletions .github/workflows/build-static-tests.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: CI Static Tests

on:
push:
jobs:
static:
name: "Static CI Tests"
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v2.3.2

- uses: actions/setup-python@v2

- uses: pre-commit/action@v2.0.0
19 changes: 19 additions & 0 deletions .github/workflows/release-cd-deliver-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Release Deliver Docs

on:
release:
types: [published]
jobs:
publish_docs:
name: "Publish the HTML Documentation"
runs-on: ubuntu-latest
steps:
- name: Checkout master
uses: actions/checkout@v2.3.2

# TODO add feature toogle for mkdocs and hugo
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@1.16
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CONFIG_FILE: mkdocs.yml
20 changes: 20 additions & 0 deletions .github/workflows/release-cd-refresh-master.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Release Deliver to Master

on:
release:
types: [published]

jobs:
publish_docs:
name: "Publish the the Release to Master"
runs-on: ubuntu-latest
steps:
- name: Checkout master
uses: actions/checkout@v2.3.2
- name: Merge Tag -> Master
uses: devmasx/merge-branch@v1.3.1
with:
type: now
from_branch: ${{ github.event.ref }}
target_branch: master
github_token: ${{ github.token }}
15 changes: 15 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Release Drafter

on:
push:
branches:
- develop

jobs:
update_release_draft:
name: Update Release Draft
runs-on: ubuntu-latest
steps:
- uses: release-drafter/release-drafter@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.3.0
hooks:
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
1 change: 1 addition & 0 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
python 3.7.1
9 changes: 9 additions & 0 deletions .yamllint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
extends: default

rules:
# 80 chars should be enough, but don't fail if a line is longer
line-length:
max: 120
level: warning
truthy: disable
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Plumbing

Collection of common Configs for Project Management and CI/CD.

probot | git | description
----------------------------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------
[settings](https://probot.github.io/apps/settings/) | [probot/settings](https://github.com/probot/settings) | Configure Github Projects by Source.
[stale](https://probot.github.io/apps/stale/) | [probot/stale](https://github.com/probot/stale) | Handle stale issues.
[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.
[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


For More Inforation take a look to the GH Page, [gh-plumbing](http://nolte.github.io/gh-plumbing).
3 changes: 3 additions & 0 deletions docs/css/overwrite.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.wy-nav-content {
max-width: 100%; !overwrite
}
42 changes: 42 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Shared Probot Configs

For Using in other Github Projects use the Probot Repo Config, more informations at [probot.github.io](https://probot.github.io/docs/best-practices/#configuration).

Example:

```ỳaml
_extends: gh-plumbing:.github/commons-stale.yml
```

The Reuseable configurations are prefixed with ```.github/commons-*.yml```.


### Shared Configs

#### Project Settings

For Central Project Configuration we use the [settings](https://probot.github.io/apps/settings/) Github App.

This Applications will be handle:

* Default Branch Configuration
* Project Description, topic etc.
* Label Colors


##### Usage

```
_extends: gh-plumbing:.github/commons-settings.yml
repository:
name: cookiecutter-gh-project
description: Template for Create Github Workflows and Projects
homepage: https://nolte.github.io/cookiecutter-gh-project
topics: templating, cookiecutter, github
```

#### Labelling

For Handle PR and Issue Labels we use a combination of Two Github Applications, [stale](https://probot.github.io/apps/stale/) for close Inactive Elements, and [boring-cyborg](https://probot.github.io/apps/boring-cyborg/) for setting labels by Existing roles, like changes at `./docs` allways get the Label `documentations`.

##### Usage
11 changes: 11 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
site_name: Github Plumping (Shared Probot Configs)
theme:
name: 'material'
docs_dir: docs/
repo_name: 'nolte/gh-plumbing'
repo_url: 'https://github.com/nolte/gh-plumbing'
markdown_extensions:
- toc:
permalink: True
extra_css:
- css/overwrite.css
3 changes: 3 additions & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pre-commit
mkdocs
mkdocs-material

0 comments on commit 91818b1

Please sign in to comment.