Skip to content

Commit f034299

Browse files
jeffabaileyjeffabailey
authored
Update Mermaid graph to link to the MD book for GQM (Not link back to GitHub) (#100)
* feat: link to graph gqm entries instead of repo chore: simplify build operations fix: delete unused files fix: update gqm graph item indexes * chore: remove dist dir and ignore
1 parent 8f08b78 commit f034299

File tree

16 files changed

+302
-248
lines changed

16 files changed

+302
-248
lines changed

‎.github/workflows/gqm_update.yml‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,33 @@ on:
88
- "measuring/metrics/**"
99

1010
workflow_dispatch:
11+
1112
jobs:
1213
generateDiagram:
1314
name: Generate Diagram
1415
runs-on: ubuntu-latest
1516
steps:
16-
- name: Checkout
17-
uses: actions/checkout@v4
17+
- uses: actions/checkout@v4
1818
with:
1919
ssh-key: ${{ secrets.DEPLOY_KEY_SSH_PRIVATE_KEY }}
20-
- name: Use Node.js
21-
uses: actions/setup-node@v3
20+
fetch-depth: 0
21+
22+
- uses: actions/setup-node@v3
2223
with:
2324
node-version: "21.x"
24-
- run: npm install --prefix ./scripts/gqm_gen
25-
- run: npm run coverage-report --prefix ./scripts/gqm_gen
26-
- name: Report NYC coverage
25+
26+
- name: Configure Git
27+
run: |
28+
git config --global user.name "github-actions[bot]"
29+
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
30+
31+
- name: Update GQM diagram
32+
run: |
33+
cd scripts/gqm_gen
34+
./update_gqm.sh
35+
36+
- name: Report coverage
37+
if: success()
2738
uses: sidx1024/report-nyc-coverage-github-action@v1.2.7
2839
with:
2940
coverage_file: ".nyc_output/nyc-coverage-report/coverage-summary.json"
30-
- run: npm run --silent start --prefix ./scripts/gqm_gen > ./new_gqm.md.tmp
31-
- run: sh ./scripts/gqm_gen/gqm_update.sh ./new_gqm.md.tmp ./measuring/use_gqm.md > ./measuring/use_gqm.md.tmp
32-
- run: rm -f ./new_gqm.md.tmp
33-
- run: mv -f ./measuring/use_gqm.md.tmp ./measuring/use_gqm.md
34-
- name: Commit GQM Diagram
35-
working-directory: ./measuring
36-
run: |
37-
git config --local user.name "github-actions[bot]"
38-
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
39-
git add .
40-
git diff --staged --quiet || (git commit -m "Update Goals Questions Metrics Graph" && git push)

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# We want to ignore our vale StylesPath
22
.github/vale/*
3-
gqm*[pngmd]
3+
gqm*[pngmd]
44
book
5+
**/dist/

‎SUMMARY.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,17 @@
1212
* [What, When and How to Measure](measuring/measuring.md)
1313
* [Goals using Metrics](measuring/goals.md)
1414
* [Use Goals, Questions, and Metrics](measuring/use_gqm.md)
15-
* [Goals](use_gqm/goals/README.md)
15+
* [Goals](measuring/goals/index.md)
16+
* [Find InnerSource Projects](measuring/goals/find-projects.md)
1617
* [Reduce Duplication](measuring/goals/reduce-duplication.md)
17-
* [Questions](use_gqm/questions/README.md)
18+
* [Questions](measuring/questions/index.md)
19+
* [What is the InnerSource Adoption Trend?](measuring/questions/adoption-trend.md)
20+
* [Who contributes to the InnerSource project?](measuring/questions/who-contributes.md)
1821
* [Who Uses](measuring/questions/who-uses.md)
19-
* [Metrics](use_gqm/metrics/README.md)
22+
* [Metrics](measuring/metrics/index.md)
23+
* [Code Contributions](measuring/metrics/code-contributions.md)
24+
* [Contribution Distance](measuring/metrics/contribution-distance.md)
25+
* [Number of InnerSource repositories](measuring/metrics/number-of-innersource-repositories.md)
2026
* [Usage Count](measuring/metrics/usage-count.md)
2127
* [Areas of Analysis](measuring/areas.md)
2228
* [Goal-Question-Metric Approach](measuring/gqm.md)

‎measuring/goals/index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Goals
2+
3+
This section contains all the goals for measuring InnerSource projects.
4+
5+
## Available Goals
6+
7+
- [Find InnerSource Projects](goals/find-projects.md) - Identify and discover InnerSource projects within the organization
8+
- [Reduce Duplication](goals/reduce-duplication.md) - Minimize code duplication through InnerSource practices
9+
10+
## How to Use
11+
12+
Each goal is defined in its own markdown file. The goals are used to:
13+
1. Define clear objectives for InnerSource initiatives
14+
2. Guide the selection of relevant questions
15+
3. Help determine appropriate metrics for measurement
16+
17+
## Adding New Goals
18+
19+
To add a new goal:
20+
1. Create a new markdown file in this directory
21+
2. Add a link to it in this README.md
22+
3. Update the GQM diagram by running the generator

‎measuring/metrics/index.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Metrics
2+
3+
This section contains all the metrics used to measure InnerSource project questions.
4+
5+
## Available Metrics
6+
7+
- [Code Contributions](metrics/code-contributions.md) - Measure the number and types of code contributions to InnerSource projects
8+
- [Contribution Distance](metrics/contribution-distance.md) - Measure how far contributions come from the original team
9+
- [Number of InnerSource repositories](metrics/number-of-innersource-repositories.md) - Track the total count of InnerSource repositories
10+
- [Usage Count](metrics/usage-count.md) - Measure how many times a component is used across the organization
11+
12+
## How to Use
13+
14+
Each metric is defined in its own markdown file. The metrics are used to:
15+
1. Quantify answers to questions
16+
2. Track progress towards goals
17+
3. Provide actionable insights
18+
19+
## Adding New Metrics
20+
21+
To add a new metric:
22+
1. Create a new markdown file in this directory
23+
2. Add a link to it in this README.md
24+
3. Update the GQM diagram by running the generator

‎measuring/questions/index.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Questions
2+
3+
This section contains all the questions used to measure InnerSource project goals.
4+
5+
## Available Questions
6+
7+
- [What is the InnerSource Adoption Trend?](questions/adoption-trend.md) - Track the growth and adoption of InnerSource practices over time
8+
- [Who contributes to the InnerSource project?](questions/who-contributes.md) - Identify and analyze the contributors to InnerSource projects
9+
- [Who Uses](questions/who-uses.md) - Track which teams and projects are using InnerSource components
10+
11+
## How to Use
12+
13+
Each question is defined in its own markdown file. The questions are used to:
14+
1. Break down goals into measurable aspects
15+
2. Guide the selection of appropriate metrics
16+
3. Help evaluate progress towards goals
17+
18+
## Adding New Questions
19+
20+
To add a new question:
21+
1. Create a new markdown file in this directory
22+
2. Add a link to it in this README.md
23+
3. Update the GQM diagram by running the generator

‎measuring/use_gqm.md‎

Lines changed: 25 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,8 @@ To test your changes see this README.md file.
2828

2929
```mermaid
3030
graph LR;
31-
32-
subgraph GQM[Goals, Questions, Metrics]
33-
34-
%% begin nodes
31+
subgraph GQM[Goals, Questions, Metrics]
32+
%% begin nodes
3533
find-projects.md[Find InnerSource Projects]
3634
reduce-duplication.md[Reduce duplication]
3735
adoption-trend.md[What is the InnerSource adoption trend?]
@@ -41,48 +39,40 @@ graph LR;
4139
contribution-distance.md[Contribution Distance]
4240
number-of-innersource-repositories.md[Number of InnerSource repositories]
4341
usage-count.md[Usage count]
44-
%% end nodes
45-
46-
%% begin edges
42+
%% begin edges
4743
find-projects.md-->who-uses.md
4844
find-projects.md-->who-contributes.md
4945
reduce-duplication.md-->who-uses.md
5046
adoption-trend.md-->number-of-innersource-repositories.md
5147
who-contributes.md-->code-contributions.md
5248
who-contributes.md-->contribution-distance.md
5349
who-uses.md-->usage-count.md
54-
%% end edges
55-
56-
%% begin clicks
57-
click find-projects.md "https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/goals/find-projects.md" "Find InnerSource Projects"
58-
click reduce-duplication.md "https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/goals/reduce-duplication.md" "Reduce duplication"
59-
click adoption-trend.md "https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/questions/adoption-trend.md" "What is the InnerSource adoption trend?"
60-
click who-contributes.md "https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/questions/who-contributes.md" "Who contributes to the InnerSource project?"
61-
click who-uses.md "https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/questions/who-uses.md" "Who uses the InnerSource project?"
62-
click code-contributions.md "https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/metrics/code-contributions.md" "Code contributions"
63-
click contribution-distance.md "https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/metrics/contribution-distance.md" "Contribution Distance"
64-
click number-of-innersource-repositories.md "https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/metrics/number-of-innersource-repositories.md" "Number of InnerSource repositories"
65-
click usage-count.md "https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/main/measuring/metrics/usage-count.md" "Usage count"
66-
%% end clicks
67-
50+
%% begin clicks
51+
click find-projects.md "/measuring/goals/find-projects" "Find InnerSource Projects"
52+
click reduce-duplication.md "/measuring/goals/reduce-duplication" "Reduce duplication"
53+
click adoption-trend.md "/measuring/questions/adoption-trend" "What is the InnerSource adoption trend?"
54+
click who-contributes.md "/measuring/questions/who-contributes" "Who contributes to the InnerSource project?"
55+
click who-uses.md "/measuring/questions/who-uses" "Who uses the InnerSource project?"
56+
click code-contributions.md "/measuring/metrics/code-contributions" "Code contributions"
57+
click contribution-distance.md "/measuring/metrics/contribution-distance" "Contribution Distance"
58+
click number-of-innersource-repositories.md "/measuring/metrics/number-of-innersource-repositories" "Number of InnerSource repositories"
59+
click usage-count.md "/measuring/metrics/usage-count" "Usage count"
6860
end
69-
subgraph Legend
70-
direction TB
71-
72-
goal[Goal]
73-
question[Question]
74-
metric[Metric]
61+
subgraph Legend
62+
direction TB
63+
goal[Goal]
64+
question[Question]
65+
metric[Metric]
7566
76-
classDef goals stroke:green,stroke-width:2px;
77-
class goal,find-projects.md,reduce-duplication.md goals
67+
classDef goals stroke:green,stroke-width:2px;
68+
class goal,find-projects.md,reduce-duplication.md goals
7869
79-
classDef questions stroke:orange,stroke-width:2px;
80-
class question,adoption-trend.md,who-contributes.md,who-uses.md questions
70+
classDef questions stroke:orange,stroke-width:2px;
71+
class question,adoption-trend.md,who-contributes.md,who-uses.md questions
8172
82-
classDef metrics stroke:purple,stroke-width:2px;
83-
class metric,code-contributions.md,contribution-distance.md,number-of-innersource-repositories.md,usage-count.md metrics
84-
end
85-
73+
classDef metrics stroke:purple,stroke-width:2px;
74+
class metric,code-contributions.md,contribution-distance.md,number-of-innersource-repositories.md,usage-count.md metrics
75+
end
8676
```
8777

8878
Add your goals, questions, and metrics into this graph! It will help you to see how others approach and interact with what you are doing.

use_gqm/goals/README.md renamed to measuring/use_gqm.md#goals

File renamed without changes.

use_gqm/metrics/README.md renamed to measuring/use_gqm.md#metrics

File renamed without changes.

use_gqm/questions/README.md renamed to measuring/use_gqm.md#questions

File renamed without changes.

0 commit comments

Comments
 (0)