search

reposense / RepoSense

Contribution analysis tool for Git repositories
https://reposense.org
MIT License
245 stars 154 forks source link

[#2161] One-Stop Config File for Code Portfolio #2172

Closed georgetayqy closed 5 months ago

georgetayqy commented 6 months ago

Part of #2161 Part of #2170

Proposed commit message

Currently, `report-config.json` is underutilised (it is only used for
defining report titles). However, considering the code portfolio
feature, we need to implement a config file that allows users to
quickly set up and deploy it to their favourite platform to host
websites.

Let's move to repurpose `report-config.json` into a YAML file that
users can use it to set up configs to build their code portfolio more
easily.

Other information

The code written for this feature is stored on the main repository to allow all team members to work on this concurrently.

Additionally, the following PRs/Tasks need to be completed before we can merge this PR:

damithc commented 6 months ago

@asdfghjkxd Let's settle the file format first. It's best to design the user view of the feature before we start implementing. Giving a full-fledged example config file is a good way to see the user POV of this feature. For example, you can start with a YAML example that is equivalent of https://github.com/reposense/RepoSense/issues/2161#issuecomment-2022776952 and we can see if that is friendly enough for the user, and flexible enough for enhancements that we might add in future. We can discuss at #2161

georgetayqy commented 6 months ago

@damithc Thank you Prof for the feedback and guidance regarding this issue! We will look into improving the current config file format and update this PR and #2161 with any new findings or points of discussion!

georgetayqy commented 6 months ago

Do note that this PR should not be merged until we have successfully migrated our CI/CD from Java 8 to Java 11. This PR requires #2183.

In the meantime, CI will always fail since the JDK versions are conflicting. We can continue to work on this PR in the meantime, taking note of the failed CI tests over here.

georgetayqy commented 5 months ago

This PR has been split into 2 separate PRs (#2191 and #2192), and will hence be closed.

github-actions[bot] commented 5 months ago

The following links are for previewing this pull request: