You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-10Lines changed: 19 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,16 +22,17 @@ The measure-innersource tool:
22
22
This tool requires an `org-data.json` file in the root of the repository that contains organizational hierarchy information. This file maps GitHub usernames to their managers, allowing the tool to determine team boundaries.
23
23
24
24
Example format of `org-data.json`:
25
+
25
26
```json
26
27
{
27
28
"username1": {
28
-
"manager": "manager1",
29
+
"manager": "manager1"
29
30
},
30
31
"username2": {
31
-
"manager": "manager1",
32
+
"manager": "manager1"
32
33
},
33
34
"username3": {
34
-
"manager": "manager2",
35
+
"manager": "manager2"
35
36
}
36
37
}
37
38
```
@@ -50,27 +51,32 @@ Below is an example of the generated InnerSource report:
50
51
### Original Commit Author: octocat (Manager: octoboss)
51
52
52
53
## Team Members that Own the Repo:
54
+
53
55
- octocat
54
56
- octoboss
55
57
- octodev1
56
58
- octodev2
57
59
58
60
## All Contributors:
61
+
59
62
- octocat
60
63
- octodev1
61
64
- octodev2
62
65
- contributor1
63
66
- contributor2
64
67
65
68
## Innersource Contributors:
69
+
66
70
- contributor1
67
71
- contributor2
68
72
69
73
## Innersource Contribution Counts:
74
+
70
75
- contributor1: 15 contributions
71
76
- contributor2: 8 contributions
72
77
73
78
## Team Member Contribution Counts:
79
+
74
80
- octocat: 25 contributions
75
81
- octodev1: 12 contributions
76
82
- octodev2: 5 contributions
@@ -88,10 +94,10 @@ All feedback regarding our GitHub Actions, as a whole, should be communicated th
88
94
89
95
1. Create a repository to host this GitHub Action or select an existing repository. This is easiest with regards to permissions if it is the same repository as the one you want to measure innersource collaboration on.
90
96
2.**Create an org-data.json file** in the root of your repository with your organization structure as described above.
91
-
4. Copy the example below (in the next section) into your repository (from step 1) and into the proper directory for GitHub Actions: `.github/workflows/` directory with the file extension `.yml` (ie. `.github/workflows/measure-innersource.yml`)
92
-
5. Update the workflow file with the appropriate configuration options as described below. The required configuration options are `REPOSITORY`, `GH_APP_ID`, `GH_APP_INSTALLATION_ID`, and `GH_APP_PRIVATE_KEY` for GitHub App Installation authentication, or `REPOSITORY` and `GH_TOKEN` for Personal Access Token (PAT) authentication. The other configuration options are optional.
93
-
6. Commit the workflow file to the default branch (often `master` or `main`)
94
-
7. Wait for the action to trigger based on the `schedule` entry or manually trigger the workflow as shown in the [documentation](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow).
97
+
3. Copy the example below (in the next section) into your repository (from step 1) and into the proper directory for GitHub Actions: `.github/workflows/` directory with the file extension `.yml` (ie. `.github/workflows/measure-innersource.yml`)
98
+
4. Update the workflow file with the appropriate configuration options as described below. The required configuration options are `REPOSITORY`, `GH_APP_ID`, `GH_APP_INSTALLATION_ID`, and `GH_APP_PRIVATE_KEY` for GitHub App Installation authentication, or `REPOSITORY` and `GH_TOKEN` for Personal Access Token (PAT) authentication. The other configuration options are optional.
99
+
5. Commit the workflow file to the default branch (often `master` or `main`)
100
+
6. Wait for the action to trigger based on the `schedule` entry or manually trigger the workflow as shown in the [documentation](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow).
0 commit comments