Refactor yaml format #2

PaulPickhardt · 2024-09-11T05:54:48Z

Splits project yaml in oss-projects and cs-groups and refactors the yaml keys.

Closes #1

github-actions · 2024-09-11T05:55:10Z

Check of projects.yaml file

✅ No problems in oss-projects yaml found

Check of cs-groups.yaml file

✅ No problems in cs-groups yaml found

github-actions · 2024-09-11T05:57:09Z

Check of projects.yaml file

❌ Missing keys in oss-projects yaml

Project index	Project name (if available)	Problems
65	GNU Taler	(Optional Key) [license] value error: expected str
66	ODNS Measurement Tools	Missing key: founder

Check of cs-groups.yaml file

❌ Missing keys in cs-groups yaml

Group index	Group name (if available)	Problems
11	None	[name] value error: expected str
12	Computational Systems Science	Missing key: handle

github-actions · 2024-09-11T05:58:35Z

Check of projects.yaml file

✅ No problems in oss-projects yaml found

Check of cs-groups.yaml file

✅ No problems in cs-groups yaml found

github-actions · 2024-09-11T06:01:28Z

Check of projects.yaml file

✅ No problems in oss-projects yaml found

Check of cs-groups.yaml file

✅ No problems in cs-groups yaml found

github-actions · 2024-09-11T06:01:35Z

🚀 PR preview

Site URL: https://tud-cs-oss-collection-preview-2.surge.sh

💾 Generated site

Artifact URL: https://github.com/tud-cs/oss-collection/actions/runs/10805860459/artifacts/1917866480

github-actions · 2024-09-11T06:01:36Z

📄 Preview of generated README.md

Preview

TU Dresden - Computer Science: Open Source Projects

This repository contains functionality to generate a HTML and markdown site of all projects entered in oss-projects.yaml and computer science groups in cs-groups.yaml.

Run init_site.py to generate a static HTML page with an overview of all projects.

Run init_readme.py to generate README of this repository containing all projects.

Add a new project

Keys in oss-projects.yaml

Name	Type	Required?
`name`	`string`	✅
`description`	`string`	✅
`groups`	`string[]`	✅
`founder`	`boolean`	✅
`maintainer`	`boolean`	✅
`contributor`	`boolean`	✅
`involved`	`boolean`	✅
`website`	`string`	Optional
`repository`	`string`	Optional
`license`	`string`	Optional
`logo`	`string`	Optional

Keys in cs-groups.yaml

Name	Type	Required?
`name`	`string`	✅
`handle`	`string`	✅
`website`	`string`	Optional

Append this template to oss-projects.yaml and fill in your data:

- name:
  description:
  website:
  repository:
  license:
  groups: []
  founder:
  maintainer:
  contributor:
  involved:
  logo:

For the logo, upload the logo to the images/projects folder and enter the relative URL to the logo in the images/projects folder.

For the groups add the handle of your computer science group to the list.

If your computer science group does not exist yet, append this template to cs-groups.yaml and fill in your data:

- name: 
  handle: 
  website:

Code Project Site

X86-Energy Libraries

Research Group: Chair of Computer Architecture (Founder) (Maintainer) (Contributor)

More information: Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam.

License: LGPL-2.1

Code Project Site

github-actions · 2024-09-11T06:25:44Z

Check of projects.yaml file

✅ No problems in oss-projects yaml found

Check of cs-groups.yaml file

✅ No problems in cs-groups yaml found

github-actions · 2024-09-11T06:25:53Z

🚀 PR preview

Site URL: https://tud-cs-oss-collection-preview-2.surge.sh

💾 Generated site

Artifact URL: https://github.com/tud-cs/oss-collection/actions/runs/10806192358/artifacts/1917933332

github-actions · 2024-09-11T06:25:53Z

📄 Preview of generated README.md

Preview

TU Dresden - Computer Science: Open Source Projects

This repository contains functionality to generate a HTML and markdown site of all projects entered in oss-projects.yaml and computer science groups in cs-groups.yaml.

Run init_site.py to generate a static HTML page with an overview of all projects.

Run init_readme.py to generate README of this repository containing all projects.

Add a new project

Keys in oss-projects.yaml

Name	Type	Required?
`name`	`string`	✅
`description`	`string`	✅
`groups`	`string[]`	✅
`founder`	`boolean`	✅
`maintainer`	`boolean`	✅
`contributor`	`boolean`	✅
`involved`	`boolean`	✅
`website`	`string`	Optional
`repository`	`string`	Optional
`license`	`string`	Optional
`logo`	`string`	Optional

Keys in cs-groups.yaml

Name	Type	Required?
`name`	`string`	✅
`handle`	`string`	✅
`website`	`string`	Optional

Append this template to oss-projects.yaml and fill in your data:

- name:
  description:
  website:
  repository:
  license:
  groups: []
  founder:
  maintainer:
  contributor:
  involved:
  logo:

For the logo, upload the logo to the images/projects folder and enter the relative URL to the logo in the images/projects folder.

For the groups add the handle of your computer science group to the list.

If your computer science group does not exist yet, append this template to cs-groups.yaml and fill in your data:

- name: 
  handle: 
  website:

Code Project Site

X86-Energy Libraries

Research Group: Chair of Computer Architecture (Founder) (Maintainer) (Contributor)

More information: Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam.

License: LGPL-2.1

Code Project Site

PaulPickhardt · 2024-09-11T07:28:26Z

I'm done with refactoring the Yaml files as supposed in issue #1. I changed chair to groups in oss-projects.yaml.

Let me know what you think @waehlisch @adeveloper-wq

waehlisch

in addition to what we just talked about.

README-template.md

README.md

…ription optional

github-actions · 2024-09-16T11:33:55Z

Check of projects.yaml file

❌ Missing keys in oss-projects yaml

Project index	Project name (if available)	Problems
0	RIOT	(Optional Key) [description] value error: expected str
1	CSBDeep	(Optional Key) [description] value error: expected str
2	stardist	(Optional Key) [description] value error: expected str
3	BrailleIO	(Optional Key) [description] value error: expected str
4	AccessibleMaps	(Optional Key) [description] value error: expected str
9	Nemo	(Optional Key) [description] value error: expected str
10	Semantic MediaWiki	(Optional Key) [description] value error: expected str
11	Wikidata Toolkit	(Optional Key) [description] value error: expected str
12	Rulewerk	(Optional Key) [description] value error: expected str
13	VLog	(Optional Key) [description] value error: expected str
14	SQID	(Optional Key) [description] value error: expected str
15	conexp-clj	(Optional Key) [description] value error: expected str
16	AN.ON	(Optional Key) [description] value error: expected str
17	dudle	(Optional Key) [description] value error: expected str
18	Veins	(Optional Key) [description] value error: expected str
19	Eclipse SUMO	(Optional Key) [description] value error: expected str
20	OMNeT++ INET Framework	(Optional Key) [description] value error: expected str
21	ACM LaTeX template	(Optional Key) [description] value error: expected str
22	OMNeT++	(Optional Key) [description] value error: expected str
23	condrust	(Optional Key) [description] value error: expected str
24	base2-mlir	(Optional Key) [description] value error: expected str
25	dfg-mlir	(Optional Key) [description] value error: expected str
26	Cinnamon	(Optional Key) [description] value error: expected str
27	Sigi-mlir	(Optional Key) [description] value error: expected str
28	Sigi-frontend	(Optional Key) [description] value erro 9E88 r: expected str
29	Mocasin	(Optional Key) [description] value error: expected str
30	Lingua Franca	(Optional Key) [description] value error: expected str
31	reactor-cpp	(Optional Key) [description] value error: expected str
32	gem5	(Optional Key) [description] value error: expected str
33	Tetris	(Optional Key) [description] value error: expected str
34	RTSim	(Optional Key) [description] value error: expected str
35	RTM Compiler	(Optional Key) [description] value error: expected str
36	OpenPME	(Optional Key) [description] value error: expected str
37	Object Teams	(Optional Key) [description] value error: expected str
38	Object Teams InvokeDynamic	(Optional Key) [description] value error: expected str
39	GraalVM with Role Support	(Optional Key) [description] value error: expected str
40	messner	(Optional Key) [description] value error: expected str
41	Mobile trace generator	(Optional Key) [description] value error: expected str
42	compy-learn	(Optional Key) [description] value error: expected str
43	dear	(Optional Key) [description] value error: expected str
44	polygym	(Optional Key) [description] value error: expected str
45	mpsym	(Optional Key) [description] value error: expected str
46	learning-compiler-graphs	(Optional Key) [description] value error: expected str
47	A 4-Approximation Algorithm for Min Max Correlation Clustering	(Optional Key) [description] value error: expected str
48	Partial Optimality in Cubic Correlation Clustering	(Optional Key) [description] value error: expected str
49	OpenGM	(Optional Key) [description] value error: expected str
52	FIRESTARTER	(Optional Key) [description] value error: expected str
53	BenchIT	(Optional Key) [description] value error: expected str
55	Linux kernel	(Optional Key) [description] value error: expected str
56	X86-Energy Libraries	(Optional Key) [description] value error: expected str
58	Score-P	(Optional Key) [description] value error: expected str
60	FAIL*	(Optional Key) [description] value error: expected str
61	CP2K	(Optional Key) [description] value error: expected str
62	RTRlib	(Optional Key) [description] value error: expected str
63	AMCS	(Optional Key) [description] value error: expected str
65	GNU Taler	(Optional Key) [description] value error: expected str
66	ODNS Measurement Tools	(Optional Key) [description] value error: expected str

Check of cs-groups.yaml file

✅ No problems in cs-groups yaml found

github-actions · 2024-09-16T11:38:55Z

Check of projects.yaml file

✅ No problems in oss-projects yaml found

Check of cs-groups.yaml file

✅ No problems in cs-groups yaml found

github-actions · 2024-09-16T11:39:02Z

🚀 PR preview

Site URL: https://tud-cs-oss-collection-preview-2.surge.sh

💾 Generated site

Artifact URL: https://github.com/tud-cs/oss-collection/actions/runs/10883022166/artifacts/1937193650

github-actions · 2024-09-16T11:39:03Z

📄 Preview of generated README.md

Preview

Open Source Projects of the Faculty of Computer Science at TU Dresden

This repository contains scripts and data to generate HTML and markdown files presenting open source software projects of the Faculty of Computer Science at TU Dresden. The sources of information are oss-projects.yaml, which describes the projects, and cs-groups.yaml, which describes the research groups involved.

Run init_site.py to generate a static HTML page with an overview of all projects.

Run init_readme.py to generate README of this repository containing all projects.

Add a new project

Keys in oss-projects.yaml

Name	Type	Required?	Description
`name`	`string`	✅	`The name of the project`
`description`	`string`	Optional	`A short description of the project`
`groups`	`string[]`	✅	`The handles of the research groups that are part of the project (See cs-groups.yaml)`
`founder`	`boolean`	✅	`If you are the founder of the project`
`maintainer`	`boolean`	✅	`If you are a maintainer of the project`
`contributor`	`boolean`	✅	`If you are a contributor of the project`
`involved`	`boolean`	✅	`If you are still involved`
`website`	`string`	Optional	`A link to the website of the project`
`repository`	`string`	Optional	`URL of the public repository`
`license`	`string`	Optional	`The license under which the project is available`
`logo`	`string`	Optional	`The relative path to the logo of your project in the projects directory (Place your logo in /website/images/projects)`

Keys in cs-groups.yaml

Name	Type	Required?	Description
`name`	`string`	✅	`The name of the research group`
`handle`	`string`	✅	`The handle of the research group`
`website`	`string`	Optional	`URL to the website of the research group`

Append this template to oss-projects.yaml and fill in your data:

- name:
  description:
  website:
  repository:
  license:
  groups: []
  founder:
  maintainer:
  contributor:
  involved:
  logo:

For the logo, upload the logo to the images/projects folder and enter the relative URL to the logo in the images/projects folder.

For the groups, add the handle of your research group to the list.

If your research group does not exist yet, append this template to cs-groups.yaml and fill in your data:

- name: 
  handle: 
  website:

License: Apache-2.0

Code Project Site

X86-Energy Libraries

Research Group: Chair of Computer Architecture (Founder) (Maintainer) (Contributor)

More information: N/A

License: LGPL-2.1

Code Project Site

github-actions · 2024-09-16T11:53:00Z

Check of projects.yaml file

✅ No problems in oss-projects yaml found

Check of cs-groups.yaml file

✅ No problems in cs-groups yaml found

github-actions · 2024-09-16T11:53:08Z

🚀 PR preview

Site URL: https://tud-cs-oss-collection-preview-2.surge.sh

💾 Generated site

Artifact URL: https://github.com/tud-cs/oss-collection/actions/runs/10883219638/artifacts/1937245100

github-actions · 2024-09-16T11:53:09Z

📄 Preview of generated README.md

Preview

Open Source Projects of the Faculty of Computer Science at TU Dresden

This repository contains scripts and data to generate HTML and markdown files presenting open source software projects of the Faculty of Computer Science at TU Dresden. The sources of information are oss-projects.yaml, which describes the projects, and cs-groups.yaml, which describes the research groups involved.

Run init_site.py to generate a static HTML page with an overview of all projects.

Run init_readme.py to generate the README of this repository containing all projects.

Add a new project

Keys in oss-projects.yaml

Name	Type	Required?	Description
`name`	`string`	✅	The name of the project
`groups`	`string[]`	✅	The handles of the research groups that are part of the project (see `cs-groups.yaml`)
`founder`	`boolean`	✅	If you are the founder of the project
`maintainer`	`boolean`	✅	If you are a maintainer of the project
`contributor`	`boolean`	✅	If you are a contributor of the project
`involved`	`boolean`	✅	If you are still involved
`description`	`string`	Optional	A short description of the project
`website`	`string`	Optional	A link to the website of the project
`repository`	`string`	Optional	URL of the public repository
`license`	`string`	Optional	The license under which the project is available
`logo`	`string`	Optional	The relative path to the logo of your project in the `projects` directory (place your logo in `/website/images/projects`)

Keys in cs-groups.yaml

Name	Type	Required?	Description
`name`	`string`	✅	The name of the research group
`handle`	`string`	✅	The handle of the research group
`website`	`string`	Optional	URL to the website of the research group

Append this template to oss-projects.yaml and fill in your data:

- name:
  groups: []
  founder:
  maintainer:
  contributor:
  involved:
  description:
  website:
  repository:
  license:
  logo:

For the logo, upload the logo to the images/projects folder and enter the relative URL to the logo in the images/projects folder.

For the groups, add the handle of your research group to the list.

If your research group does not exist yet, append this template to cs-groups.yaml and fill in your data:

- name: 
  handle: 
  website:

License: Apache-2.0

Code Project Site

X86-Energy Libraries

Research Group: Chair of Computer Architecture (Founder) (Maintainer) (Contributor)

More information: N/A

License: LGPL-2.1

Code Project Site

github-actions · 2024-09-16T11:54:20Z

Check of projects.yaml file

✅ No problems in oss-projects yaml found

Check of cs-groups.yaml file

✅ No problems in cs-groups yaml found

github-actions · 2024-09-16T11:54:28Z

🚀 PR preview

Site URL: https://tud-cs-oss-collection-preview-2.surge.sh

💾 Generated site

Artifact URL: https://github.com/tud-cs/oss-collection/actions/runs/10883239216/artifacts/1937249839

github-actions · 2024-09-16T11:54:29Z

📄 Preview of generated README.md

Preview

Open Source Projects of the Faculty of Computer Science at TU Dresden

This repository contains scripts and data to generate HTML and markdown files presenting open source software projects of the Faculty of Computer Science at TU Dresden. The sources of information are oss-projects.yaml, which describes the projects, and cs-groups.yaml, which describes the research groups involved.

Run init_site.py to generate a static HTML page with an overview of all projects.

Run init_readme.py to generate the README of this repository containing all projects.

Add a new project

Keys in oss-projects.yaml

Name	Type	Required?	Description
`name`	`string`	✅	The name of the project
`groups`	`string[]`	✅	The handles of the research groups that are part of the project (see `cs-groups.yaml`)
`founder`	`boolean`	✅	If you are the founder of the project
`maintainer`	`boolean`	✅	If you are a maintainer of the project
`contributor`	`boolean`	✅	If you are a contributor of the project
`involved`	`boolean`	✅	If you are still involved
`description`	`string`	Optional	A short description of the project
`website`	`string`	Optional	A link to the website of the project
`repository`	`string`	Optional	URL of the public repository
`license`	`string`	Optional	The license under which the project is available
`logo`	`string`	Optional	The relative path to the logo of your project in the `projects` directory (place your logo in `/website/images/projects`)

Keys in cs-groups.yaml

Name	Type	Required?	Description
`name`	`string`	✅	The name of the research group
`handle`	`string`	✅	The handle of the research group
`website`	`string`	Optional	URL to the website of the research group

Append this template to oss-projects.yaml and fill in your data:

- name:
  groups: []
  founder:
  maintainer:
  contributor:
  involved:
  description:
  website:
  repository:
  license:
  logo:

For the logo, upload the logo to the website/images/projects folder and enter the relative URL to the logo in the website/images/projects folder.

For the groups, add the handle of your research group to the list.

If your research group does not exist yet, append this template to cs-groups.yaml and fill in your data:

- name: 
  handle: 
  website:

License: Apache-2.0

Code Project Site

X86-Energy Libraries

Research Group: Chair of Computer Architecture (Founder) (Maintainer) (Contributor)

More information: N/A

License: LGPL-2.1

Code Project Site

PaulPickhardt · 2024-09-16T11:58:39Z

The description is now optional and I added your suggestions to the readme @waehlisch

PaulPickhardt added 7 commits September 10, 2024 13:46

Refactor yaml structure and adjust readme template and generation

c5fe352

Adjsut init_site script to new data structure

453ed32

Fix typos

8099bf3

Fix typo

601912b

Fix typo

ac9e1b2

Fix typo

0bcda0f

Adjust check keys

27c3447

Workflow test (missing keys and value errors in yaml)

8000

41094e2

Revert workflow test

1dbda79

Fix image to logo

16c4ad3

PaulPickhardt requested review from waehlisch and adeveloper-wq September 11, 2024 07:28

waehlisch requested changes Sep 16, 2024

View reviewed changes

README-template.md Outdated Show resolved Hide resolved

README-template.md Outdated Show resolved Hide resolved

README-template.md Outdated Show resolved Hide resolved

README-template.md Outdated Show resolved Hide resolved

waehlisch reviewed Sep 16, 2024

View reviewed changes

README.md Show resolved Hide resolved

Adjust Readme template and remove lorem ipsum descriptions, make desc…

cea2b55

…ription optional

Remove key description for empty descriptions

22ca77b

Adjust Readme

7f3ae86

Fix relative path in readme template to images

a7d0f43

PaulPickhardt requested a review from waehlisch September 16, 2024 11:57

waehlisch approved these changes Sep 17, 2024

View reviewed changes

waehlisch merged commit 730a219 into main Sep 17, 2024
1 check passed

Refactor yaml format #2

Refactor yaml format #2

Uh oh!

Conversation

Uh oh!

Check of projects.yaml file

Check of cs-groups.yaml file

Uh oh!

Check of projects.yaml file

Check of cs-groups.yaml file

Uh oh!

Check of projects.yaml file

Check of cs-groups.yaml file

Uh oh!

Check of projects.yaml file

Check of cs-groups.yaml file

Uh oh!

🚀 PR preview

💾 Generated site

Uh oh!

📄 Preview of generated README.md

TU Dresden - Computer Science: Open Source Projects

Add a new project

Projects

A 4-Approximation Algorithm for Min Max Correlation Clustering

AccessibleMaps

ACM LaTeX template

AMCS

AN.ON

base2-mlir

BenchIT

BrailleIO

Cinnamon

compy-learn

condrust

conexp-clj

CP2K

CSBDeep

dear

dfg-mlir

dudle

Eclipse SUMO

FAIL*

FIRESTARTER

gem5

GNU Taler

GraalVM with Role Support

Graphs and graph algorithms in C++

learning-compiler-graphs

libAPR, pyapr, apr-napari

Lingua Franca

Linux kernel

Marray

messner

Mobile trace generator

Mocasin

MOSAICsuite

mpsym

Nemo

Object Teams

Object Teams InvokeDynamic

ODNS Measurement Tools

OMNeT++

OMNeT++ INET Framework

OpenFPM

OpenGM

OpenPME

Partial Optimality in Cubic Correlation Clustering

polygym

PrioBike

reactor-cpp

RIOT

RTM Compiler

RTRlib

RTSim

Rulewerk

Scenery

Score-P

Score-P autotools

Score-P libsensors Plugin Counter