-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path.seed-config.yaml
105 lines (87 loc) · 3.57 KB
/
.seed-config.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
project:
name: "Godocit"
state: "unstable"
website: "https://godocit.okkur.org"
oneLiner: "Create documentation needed issues across different repositories"
description: |
When a PR introduces a new feature that requires documentation, this action
can automatically create an issue on your website's repository to add
documentation for that new feature.
version: "v0.1.0"
mainLicense: "apache2"
docsLicense: "CCBySa"
vision:
type: ""
overview: |
Provide an automatic flow for keeping track of documentation.
items:
- 'Works easily by just adding a "documentation needed" label on the PR'
- "Create issues on different repositories"
concept: "Godocit's core concept is to provide an automatic tool to never miss
documentation for new features."
aim: "Godocit provides an easy and fast way to create documentation issues for
new features and keep track of undocumented features"
readme:
usageExample: |
For using godocit you first need to create a Github App and install it on your
user or organization that has **write** access to the target repository.
For more information read the ["Authenticating with GitHub Apps"](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/) page.
Note: The generated private key for the GitHub Action should be stored in a
secret named `PrivateKey` on the source repository. For more information
about secrets, read the [Creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) page.
After creating the app and installing it on your user or organization, write the
following config in `.github/workflows/godocit.yml` file in your source repository:
```
name: CI
on:
pull_request:
types: [labeled]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Create the documentation issues
uses: okkur/[email protected]
with:
targetRepo: 'USER/REPO'
env:
PRIVATE_KEY: ${{ secrets.PrivateKey }}
INSTALLATION_ID: ${{ secrets.InstallationID }}
```
Replace the `targetRepo` input with the target repository's name.
Then after activating the action on the source repository, create the
`PrivateKey` and `InstallationID` secrets on the source repository and fill
them with the GitHub App's **Private Key** and **Installation ID**.
Now that GitHub Action, workflow and the secrets are setup, you can add the
"documentation needed" label. Then a job will get
activated and creates a "Documentation Needed" issue on the target repository.
contributionLinks:
issueTemplate: "/.github/ISSUE_TEMPLATE.md"
starterIssues: "https://github.com/okkur/actions-godocit/labels/starter%20issue"
emails:
commercialSupport: "[email protected]"
security: "[email protected]"
coc: "[email protected]"
copyright:
owner: "The Godocit authors"
year: "2019"
cla:
copyrightHolder: "nzt.ventures GmbH"
mail: "[email protected]"
maintainers:
- name: "Michael Grosser"
nick: "stp-ip"
repo:
link: "https://godocit.okkur.org/repo"
type: "Github"
badges:
- image: "https://img.shields.io/badge/state-unstable-blue.svg"
alt: "state"
- image: "https://img.shields.io/github/release/okkur/actions-godocit.svg"
link: "https://godocit.okkur.org/releases"
alt: "release"
- image: "https://img.shields.io/github/license/okkur/actions-godocit.svg"
link: "LICENSE"
alt: "license"
reposeed:
configVersion: "v1"