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

georgetayqy · 2024-03-25T15:05:45Z

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:

Migrate CI/CD from Java 8 to Java 11 [#2177] Migrate to Java 11 Syntax and Features #2183

damithc

Added some comments about the file format.

damithc · 2024-03-27T13:00:44Z

docs/ug/report-config.yaml

+authorGithubId: Sample Author Github ID
+branches:
+  - name: Branch 1
+    blurb: Blurb 1


Blurb should allow a few paragraph of markdown text. So, yml might not be the right format for this config file.

@damithc There are ways to incorporate multi-line strings into YAML files here, we could perhaps include this into the docs to let users know how they can tailor the blurbs to suit their use cases (multi-paragraph vs long single paragraph text)

damithc · 2024-03-27T13:01:39Z

docs/ug/report-config.yaml

@@ -0,0 +1,11 @@
+repoUrl: github.com/user/repo
+reportTitle: RepoSense Report
+authorDisplayName: Sample Author


@damithc Sure thing, will remove these from the YAML file and other associated classes in a future commit.

damithc · 2024-03-27T13:31:53Z

docs/ug/report-config.yaml

+  - name: Branch 2
+    blurb: Blurb 2
+startDate: 2020-01-01
+endDate: 9999-12-31


See #2161 (comment) for an example that seems intuitive from the user POV

@damithc Just wanted to clarify, do you mean that we should include the configs within the markdown files itself, and have the backend parse the markdown files and then generate the reports, or that the overall order/style/keys in the YAML file should match what was used in the example provided?

@asdfghjkxd I wasn't specifically using markdown either. It is just a custom format that makes sense from the user's point of view. I'm fine if something close can be achieved by YAML or some other commonly-used format, provided it makes sense from the user (i.e., the user shouldn't have to do a lot of extra work just to conform to the file format)

@damithc I see, sure thing, we will try to design a user-friendly and convenient config file format and update this PR and parent issue with any new findings/improvements!

damithc · 2024-03-28T04:36:03Z

@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 #2161 (comment) 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 · 2024-03-28T09:03:56Z

@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 · 2024-04-02T07:28:48Z

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.

* [#2120] Update RepoSense contributors in documentation (#2138) The current About page on the RepoSense docs does not reflect the updated list of developers working on RepoSense. Let's move to update the list to more accurately reference the current developers of RepoSense. * [#2001] Extract c-zoom-commit-message component from views/c-zoom (#2132) Many of the frontend files are difficult to navigate through due to the large file sizes. As we add more features to the frontend, it is getting harder to maintain. This is also very unfriendly towards new contributors. Let us break down frontend files in a logical manner, continuing with extracting c-zoom-commit-message from views/c-zoom. * [#2142] Fix Vulnerabilities (#2143) Fix vulnerabilities in codebase. There are existing vulnerabilities in the codebase. Let's fix as many as possible. * Bump follow-redirects from 1.15.4 to 1.15.6 in /frontend (#2160) Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.4 to 1.15.6. - [Release notes](https://github.com/follow-redirects/follow-redirects/releases) - [Commits](follow-redirects/follow-redirects@v1.15.4...v1.15.6) * Bump webpack-dev-middleware from 5.3.3 to 5.3.4 in /frontend (#2168) Bumps [webpack-dev-middleware](https://github.com/webpack/webpack-dev-middleware) from 5.3.3 to 5.3.4. - [Release notes](https://github.com/webpack/webpack-dev-middleware/releases) - [Changelog](https://github.com/webpack/webpack-dev-middleware/blob/v5.3.4/CHANGELOG.md) - [Commits](webpack/webpack-dev-middleware@v5.3.3...v5.3.4) * [#2151] Update LoadingOverlay and Minor Versions of Node Dependencies (#2152) Update LoadingOverlay and Minor Versions of Node Dependencies Some dependencies are not at their latest minor or patch releases. Let's update these dependencies, as well as LoadingOverlay as part of a bug fix. * Factor out markdown parser * [#2109] Add search by tag functionality (#2167) Add search by tag functionality It can be useful to search author/repos by git tags. Let's add this functionality to make it easier to filter by tags. This commit also fixes a bug that existed in a previous version of the feature which resulted in all users being shown to belong to same group. * Refactor chunks * Fix style * Add parts of blurb * Fix linting * Fix style * Fix missing html parsing * Remove unused import --------- Co-authored-by: George Tay <george_tay@u.nus.edu> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: jonasongg <120372506+jonasongg@users.noreply.github.com>

This reverts commit 6e58493.

…poSense into 2161-code-portfolio

georgetayqy · 2024-04-15T06:43:00Z

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

github-actions · 2024-04-15T06:43:13Z

The following links are for previewing this pull request:

Dashboard Preview: https://dashboard-2172-pr-reposense-reposense.surge.sh
Docs Preview: https://docs-2172-pr-reposense-reposense.surge.sh

Update with report config YAML files

2db2ac0

georgetayqy added the s.ToDiscuss label Mar 25, 2024

georgetayqy requested review from supermii2, sopa301 and jonasongg March 25, 2024 15:05

Undo SummaryJson changes

202d247

georgetayqy marked this pull request as ready for review March 26, 2024 02:19

georgetayqy added 3 commits March 27, 2024 20:44

Update ReportConfiguration to support branches

f64f6ed

Update Report Configuration docs

356299a

Merge branch 'master' into 2161-code-portfolio

ffd4912

damithc reviewed Mar 27, 2024

View reviewed changes

georgetayqy added 4 commits March 28, 2024 22:27

Update YAML format

2cbb662

Fix environmental error

9190fb0

Implement Markdown Parser

b611f29

Fix test cases

6573637

georgetayqy linked an issue Apr 2, 2024 that may be closed by this pull request

Migrate to Java 11 Syntax and Features #2177

Closed

4 tasks

georgetayqy removed a link to an issue Apr 2, 2024

Migrate to Java 11 Syntax and Features #2177

Closed

4 tasks

sopa301 and others added 2 commits April 4, 2024 10:22

Merge branch 'master' into 2161-code-portfolio

4259db3

georgetayqy mentioned this pull request Apr 4, 2024

Migrate to Java 11 Syntax and Features #2177

Closed

4 tasks

georgetayqy and others added 4 commits April 4, 2024 11:08

Add tests for BlurbMap and ReportConfiguration

43f1c14

Remove manual testing artefact

d5fd31a

Upgrade checkstyle and fix checkstyle errors

6e58493

Revert "Upgrade checkstyle and fix checkstyle errors"

7924629

This reverts commit 6e58493.

georgetayqy added s.ToReview and removed s.ToDiscuss labels Apr 7, 2024

Update regex

cbf622d

georgetayqy and others added 5 commits April 8, 2024 12:22

Remove unused methods

fa95f75

Update Regex to accept 0 or more characters

4299ff2

Modify css

1145f8e

Merge branch '2161-code-portfolio' of https://github.com/reposense/Re…

7c94fea

…poSense into 2161-code-portfolio

Update Yaml file format

6ee3249

georgetayqy requested a review from a team April 8, 2024 12:15

sopa301 and others added 9 commits April 9, 2024 00:42

Add blurbs to frontend files

48c873b

Fix style

50f6ec6

Fix style

941f420

Move blurb parsing into ArgsParser

6dd383b

Merge branch '2161-code-portfolio' of https://github.com/reposense/Re…

d628e85

…poSense into 2161-code-portfolio

Fix tests

68ea84e

Change config files

28d9c84

Update blurb map parsing

83329cf

Merge branch '2161-code-portfolio' of https://github.com/reposense/Re…

f70ead4

…poSense into 2161-code-portfolio

georgetayqy closed this Apr 15, 2024

ckcherry23 mentioned this pull request May 14, 2024

Move title.md default location to configs folder #2205

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

georgetayqy commented Mar 25, 2024 •

edited

Loading

damithc left a comment

damithc Mar 27, 2024

georgetayqy Mar 27, 2024

damithc Mar 27, 2024

georgetayqy Mar 27, 2024

damithc Mar 27, 2024

georgetayqy Mar 27, 2024

damithc Mar 27, 2024

georgetayqy Mar 28, 2024

damithc commented Mar 28, 2024

georgetayqy commented Mar 28, 2024

georgetayqy commented Apr 2, 2024 •

edited

Loading

georgetayqy commented Apr 15, 2024

github-actions bot commented Apr 15, 2024

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

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

Conversation

georgetayqy commented Mar 25, 2024 • edited Loading

Proposed commit message

Other information

damithc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

damithc commented Mar 28, 2024

georgetayqy commented Mar 28, 2024

georgetayqy commented Apr 2, 2024 • edited Loading

georgetayqy commented Apr 15, 2024

github-actions bot commented Apr 15, 2024

georgetayqy commented Mar 25, 2024 •

edited

Loading

georgetayqy commented Apr 2, 2024 •

edited

Loading