-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
split the docs for better create cross page links
- Loading branch information
Showing
9 changed files
with
171 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,3 +2,4 @@ site | |
|
||
.github/styles/* | ||
!.github/styles/.keep | ||
.task |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
|
||
# Labelling | ||
|
||
For Handle PR and Issue Labels use [boring-cyborg](https://probot.github.io/apps/boring-cyborg/) for setting labels by Existing roles, like changes at `./docs` always get the Label `documentations`. | ||
|
||
## Usage | ||
|
||
```yaml | ||
{% | ||
include "../../.github/boring-cyborg.yml" | ||
%} | ||
``` | ||
|
||
## Labelling rules | ||
|
||
```yaml | ||
{% | ||
include "../../.github/commons-boring-cyborg.yml" | ||
start="# <!--td-commons-settings-labels-start-->" | ||
end="# <!--td-commons-settings-labels-end-->" | ||
%} | ||
``` | ||
|
||
## Existing labels | ||
|
||
```yaml | ||
{% | ||
include "../../.github/commons-settings.yml" | ||
start="# <!--td-commons-settings-labels-start-->" | ||
end="# <!--td-commons-settings-labels-end-->" | ||
%} | ||
``` | ||
The labels will be pre-configured by use the [Settings](#project-settings) GitHub Application. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Publish Docs (mkdocs) | ||
|
||
This Action is part of the template Project [nolte/cookiecutter-gh-project](https://github.com/nolte/cookiecutter-gh-project). | ||
|
||
## Usage | ||
|
||
**TBD** | ||
|
||
## Central Configuration | ||
|
||
The full Action configuration will be used from a central place. | ||
|
||
```yaml | ||
{% | ||
include "../../.github/workflows/reusable-mkdocs.yaml" | ||
%} | ||
``` | ||
from `.github/workflows/reusable-mkdocs.yaml`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Release Process | ||
|
||
using [release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) for generate tagged release and generated release artefacts. This Action is part of the template Project [nolte/cookiecutter-gh-project](https://github.com/nolte/cookiecutter-gh-project). | ||
|
||
## Usage | ||
|
||
|
||
Two configurations must be created for use. The **GitHub Workflow**, and the **Probot** settings. | ||
|
||
### Workflow | ||
|
||
```yaml | ||
--- | ||
name: Release Drafter | ||
|
||
on: | ||
push: | ||
branches: | ||
- develop | ||
|
||
jobs: | ||
update_release_draft: | ||
uses: nolte/gh-plumbing/.github/workflows/reusable-release-drafter.yml@v1.1.8 | ||
secrets: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
``` | ||
*(from `.github/workflows/release-drafter.yml`)* | ||
|
||
### Probot | ||
|
||
```sh | ||
--- | ||
# These settings are synced to GitHub by https://probot.github.io/apps/release-drafter/ | ||
|
||
_extends: gh-plumbing:.github/commons-release-drafter.yml | ||
|
||
``` | ||
*(from `.github/release-drafter.yml`)* | ||
|
||
take a look to the release draft from this project: | ||
|
||
[![.github/workflows/release-drafter.yml](https://github.com/nolte/gh-plumbing/actions/workflows/release-drafter.yml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/release-drafter.yml) | ||
|
||
## Central Configuration | ||
|
||
### Workflow | ||
|
||
The full Action configuration will be used from a central place. | ||
|
||
```yaml | ||
{% | ||
include "../../.github/workflows/reusable-release-drafter.yml" | ||
%} | ||
``` | ||
from `.github/workflows/reusable-release-drafter.yml`. | ||
|
||
|
||
### Probot | ||
|
||
```yaml | ||
{% | ||
include "../../.github/commons-release-drafter.yml" | ||
%} | ||
``` | ||
from `.github/commons-release-drafter.yml`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Project settings | ||
|
||
For Central Project Configuration 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 | ||
|
||
### Probot | ||
|
||
```yaml | ||
_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 | ||
``` | ||
## Central Configuration¶ | ||
### Probot | ||
```yaml | ||
{% | ||
include "../../.github/commons-settings.yml" | ||
%} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Static Tests (linting) | ||
|
||
Generate a base set of workflows for execute Static Tests, like linting. | ||
|
||
* [pre-commit/action](https://github.com/pre-commit/action) | ||
* [zbeekman/EditorConfig-Action](https://github.com/zbeekman/EditorConfig-Action) | ||
|
||
## Usage | ||
|
||
## Central Configuration |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters