Skip to content

Commit 2aa00b7

Browse files
committed
use tables for summaries
1 parent 770bba6 commit 2aa00b7

File tree

1 file changed

+28
-22
lines changed

1 file changed

+28
-22
lines changed

README.md

+28-22
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,17 @@ infrastructure.
99

1010
### Normalize Repos
1111

12-
- Workflow
13-
- Status: [![Normalize Repos][norm_badge]][norm_link]
14-
- Schedule: Hourly at 45 minutes past the hour (`**:45`)
15-
- YAML: [`normalize_repos.yml`][norm_pr_yml]
16-
- Script: `normalize_repos.py`
17-
- Common Modules: [`ccos/`](ccos/)
18-
- Specific Modules: [`ccos/norm/`](ccos/norm/)
19-
- Required Environment Variables:
20-
- `ADMIN_GITHUB_TOKEN`
12+
| **Workflow** | | |
13+
| -- | --: | --- |
14+
| | Status: | [![Normalize Repos][norm_badge]][norm_link] |
15+
| | Schedule: | Hourly at 45 minutes past the hour (`**:45`) |
16+
| | YAML: | [`normalize_repos.yml`][norm_pr_yml] |
17+
| **Script** | | |
18+
| | File: | [`normalize_repos.py`][norm_file] |
19+
| | Common Modules: | [`ccos/`](ccos/) |
20+
| | Specific Modules: | [`ccos/norm/`](ccos/norm/) |
21+
| **Env** | | |
22+
| | Required: | `ADMIN_GITHUB_TOKEN` |
2123

2224
This workflow ensures that all active repositories in the creativecommons
2325
GitHub organization are consistent in the following ways:
@@ -27,29 +29,32 @@ GitHub organization are consistent in the following ways:
2729
This script will only update color and description of existing labels or create
2830
new labels. It will never delete labels.
2931

30-
[norm_pr_yml]: .github/workflows/normalize_repos.yml
3132
[norm_badge]: https://github.com/creativecommons/ccos-scripts/actions/workflows/normalize_repos.yml/badge.svg
3233
[norm_link]: https://github.com/creativecommons/ccos-scripts/actions/workflows/normalize_repos.yml
34+
[norm_pr_yml]: .github/workflows/normalize_repos.yml
35+
[norm_file]: normalize_repos.py
3336

3437

3538
### Push data to CC Open Source
3639

37-
- Workflow
38-
- Status: [![Push data to CC Open Source][data_badge]][data_link]
39-
- Schedule: Daily at midnight:15 (`00:15`)
40-
- YAML: [`push_data_to_ccos.yml`][push_ccos_yml]
41-
- Script: `push_data_to_ccos.py`
42-
- Common Modules: [`ccos/`](ccos/)
43-
- Specific Modules: [`ccos/data/`](ccos/data/)
44-
- Required Environment Variables:
45-
- `ADMIN_ASANA_TOKEN`
46-
- `ADMIN_GITHUB_TOKEN`
40+
| **Workflow** | | |
41+
| -- | --: | --- |
42+
| | Status: | [![Push data to CC Open Source][data_badge]][data_link] |
43+
| | Schedule: | Daily at midnight:15 (`00:15`) |
44+
| | YAML: | [`push_data_to_ccos.yml`][push_ccos_yml] |
45+
| **Script** | | |
46+
| | File: | [`push_data_to_ccos.py`][data_file] |
47+
| | Common Modules: | [`ccos/`](ccos/) |
48+
| | Specific Modules: | [`ccos/data/`](ccos/data/) |
49+
| **Env** | | |
50+
| | Required: | `ADMIN_ASANA_TOKEN` |
51+
| | Required: | `ADMIN_GITHUB_TOKEN` |
4752

4853
This workflow retreives data from Asana, formats it as a lektor databag, and
4954
pushes it to CC Open Source website source repository:
5055
- Data Source: [Community Team Tracking - Asana][asana] (limited access)
5156
- Data Destination:
52-
- [`creativecommons.github.io-source`][ccos_source]
57+
- [`creativecommons/creativecommons.github.io-source`][ccos_source]
5358
- [`databags/community_team_members.json`][db_community]
5459
- [`databags/repos.json`][db_repos]
5560

@@ -59,6 +64,8 @@ The destination data is used by the following pages:
5964

6065
[data_badge]: https://github.com/creativecommons/ccos-scripts/actions/workflows/push_data_to_ccos.yml/badge.svg
6166
[data_link]: https://github.com/creativecommons/ccos-scripts/actions/workflows/push_data_to_ccos.yml
67+
[push_ccos_yml]: .github/workflows/push_data_to_ccos.yml
68+
[data_file]: push_data_to_ccos.py
6269
[ctlistpage]: https://opensource.creativecommons.org/community/community-team/members/
6370
[osproj]: https://opensource.creativecommons.org/contributing-code/projects/
6471
[asana]: https://app.asana.com/0/1172465506923657/list
@@ -92,7 +99,6 @@ The destination data is used by the following pages:
9299

93100
[community_pr_yml]: .github/workflows/add_community_pr.yml
94101
[vocab_in_progress]: https://github.com/orgs/creativecommons/projects/13
95-
[push_ccos_yml]: .github/workflows/push_data_to_ccos.yml
96102
[sync_team_yml]: .github/workflows/sync_community_team.yml
97103
[track_backlog]: .github/workflows/track_backlog.yml
98104
[active_sprint]: https://github.com/orgs/creativecommons/projects/7

0 commit comments

Comments
 (0)