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

asdfghjkxd · 2024-04-15T06:41:55Z

Part of #2161

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

Requires CI/CD to be updated to Java 11:

[#2177] Migrate to Java 11 Syntax and Features #2183

docs/ug/configFiles.md

…implement-one-stop-config-file

jonasongg

LGTM!

ckcherry23

Great work on the YAML config file @asdfghjkxd! I have some questions and left them as comments below.

config/report-config.yaml

docs/ug/configFiles.md

ckcherry23 · 2024-05-11T19:49:31Z

docs/ug/configFiles.md

@@ -107,12 +107,22 @@ e.g.: `example.java` in `example-repo` can either be in the `test` group or the

 <!-- ==================================================================================================== -->

-## `report-config.json`
+## `report-config.yaml`


Can we also update the --config flag under 'CLI syntax reference' to include report-config.yaml instead of json? https://docs-2192-pr-reposense-reposense.surge.sh/ug/cli.html#config-c

Let's also update the 'Customize using CSV config files' heading on the 'Customizing Reports` page to include YAML or remove file types entirely. https://docs-2192-pr-reposense-reposense.surge.sh/ug/customizingReports.html#customize-using-csv-config-files

ckcherry23 · 2024-05-11T19:56:19Z

src/main/java/reposense/model/reportconfig/ReportBranchData.java

+ public static final List<String> DEFAULT_FILE_FORMATS = List.of(
+ "override:java", "md", "fxml"
+ );
+ public static final List<String> DEFAULT_IGNORE_GLOB_LIST = List.of(
+ "docs**"
+ );
+ public static final List<String> DEFAULT_IGNORE_COMMITS_LIST = List.of(
+ "2fb6b9b2dd9fa40bf0f9815da2cb0ae8731436c7",
+ "c5a6dc774e22099cd9ddeb0faff1e75f9cf4f151",
+ "cd7f610e0becbdf331d5231887d8010a689f87c7",
+ "768015345e70f06add2a8b7d1f901dc07bf70582"
+ );
+ public static final List<String> DEFAULT_IGNORE_AUTHORS_LIST = List.of(
+ "author1",
+ "author2"
+ );
+ public static final boolean DEFAULT_IS_FIND_PREVIOUS_AUTHOR = false;
+ public static final boolean DEFAULT_IS_SHALLOW_CLONING = true;
+ public static final boolean DEFAULT_IS_IGNORE_STANDALONE_CONFIG = true;


I'm not sure if we need these hardcoded default values here? Check for this in the other files inside reportconfig/ too.

I believe they are present for testing purposes (creating default instances), but I will have to check before reverting back to you!

If they're just for tests, could we move them into the test files like we do for test defaults for the other classes? It doesn't seem like these values are useful defaults outside of the tests.

config/report-config.yaml

docs/ug/configFiles.md

…sdfghjkxd/RepoSense into implement-one-stop-config-file

src/systemtest/resources/ConfigSystemTest/report-config.yaml

gok99

Is this PR complete? I don't see how this config is handled beyond being parsed and having the name read from in SummaryJson.java. How does the config fit into the existing processing flow and modify RepoConfiguration (along with the interaction with the conflicting CSV fields)?

gok99 · 2024-05-12T15:01:45Z

config/report-config.yaml

+title: RepoSense Report
+group-details:
+ - repo: https://github.com/reposense/testrepo-Delta.git
+ groups:


Why not merge groups with the repo details in repos?

I closely followed the structure of the existing CSV files when modelling the config file, but on closer inspection, putting groups into repos might have been much cleaner! Will work on this in the upcoming weeks!

gok99 · 2024-05-12T15:05:35Z

src/main/java/reposense/parser/ReportConfigYamlParser.java

+ }
+
+ @Override
+ protected ReportConfiguration fromJson(Gson gson, Path path, Type type) throws IOException , JsonMappingException {


fromYaml?

I initially wanted to follow the same interface as JsonParser, but in retrospect it might have been better to declare another abstract YamlParser that implements similar interface methods as JsonParser. I could probably work on this in the upcoming weeks if I have some time; anyone is welcome to jump in and refactor the code if this feature is needed urgently!

Implement one-stop config file

1b6e79b

github-actions bot requested a deployment to dashboard-2192 April 15, 2024 06:42 Abandoned

github-actions bot requested a deployment to docs-2192 April 15, 2024 06:42 Abandoned

asdfghjkxd mentioned this pull request Apr 15, 2024

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

Closed

1 task

asdfghjkxd requested a review from a team April 16, 2024 06:49

asdfghjkxd added the s.ToReview label Apr 17, 2024

jonasongg reviewed Apr 18, 2024

View reviewed changes

docs/ug/configFiles.md Outdated Show resolved Hide resolved

jonasongg requested review from a team April 18, 2024 17:55

Merge branch 'master' into implement-one-stop-config-file

a6e30e7

github-actions bot requested a deployment to dashboard-2192 April 27, 2024 07:32 Abandoned

github-actions bot requested a deployment to docs-2192 April 27, 2024 07:32 Abandoned

Update report-config.yaml file

b76b29e

github-actions bot requested a deployment to dashboard-2192 April 27, 2024 08:22 Abandoned

github-actions bot requested a deployment to docs-2192 April 27, 2024 08:22 Abandoned

Merge branch 'master' of https://github.com/reposense/RepoSense into …

15bbf0e

…implement-one-stop-config-file

github-actions bot requested a deployment to dashboard-2192 May 6, 2024 11:56 Abandoned

github-actions bot requested a deployment to docs-2192 May 6, 2024 11:56 Abandoned

Merge branch 'master' into implement-one-stop-config-file

0e83f36

github-actions bot requested a deployment to dashboard-2192 May 7, 2024 04:16 Abandoned

github-actions bot requested a deployment to docs-2192 May 7, 2024 04:16 Abandoned

Update config file in cypress

65cf7dd

github-actions bot requested a deployment to dashboard-2192 May 7, 2024 04:48 Abandoned

github-actions bot requested a deployment to docs-2192 May 7, 2024 04:48 Abandoned

Fix title name

0a4b72d

github-actions bot temporarily deployed to dashboard-2192 May 7, 2024 04:49 Inactive

github-actions bot temporarily deployed to docs-2192 May 7, 2024 04:49 Inactive

jonasongg approved these changes May 11, 2024

View reviewed changes

ckcherry23 requested changes May 11, 2024

View reviewed changes

ckcherry23 requested a review from a team May 11, 2024 20:03

gok99 mentioned this pull request May 11, 2024

[#2170] Add Blurbs for Repos #2191

Merged

1 task

gok99 reviewed May 11, 2024

View reviewed changes

config/report-config.yaml Show resolved Hide resolved

docs/ug/configFiles.md Outdated Show resolved Hide resolved

Merge branch 'master' into implement-one-stop-config-file

907e1a7

github-actions bot temporarily deployed to dashboard-2192 May 12, 2024 09:49 Inactive

github-actions bot temporarily deployed to docs-2192 May 12, 2024 09:49 Inactive

asdfghjkxd added 2 commits May 12, 2024 19:41

Update report-config.yaml format

ab3aff4

Merge branch 'implement-one-stop-config-file' of https://github.com/a…

98db5d8

…sdfghjkxd/RepoSense into implement-one-stop-config-file

github-actions bot temporarily deployed to dashboard-2192 May 12, 2024 11:42 Inactive

github-actions bot temporarily deployed to docs-2192 May 12, 2024 11:42 Inactive

ckcherry23 reviewed May 12, 2024

View reviewed changes

src/systemtest/resources/ConfigSystemTest/report-config.yaml Outdated Show resolved Hide resolved

Update docs for report-config.yaml

c20e450

github-actions bot requested a deployment to dashboard-2192 May 12, 2024 12:18 Abandoned

github-actions bot requested a deployment to docs-2192 May 12, 2024 12:18 Abandoned

Update URLs

66cd719

github-actions bot deployed to dashboard-2192 May 12, 2024 12:21 View deployment

github-actions bot deployed to docs-2192 May 12, 2024 12:21 View deployment

gok99 mentioned this pull request May 12, 2024

One-Stop Config File for Code Portfolio #2161

Open

ckcherry23 requested a review from a team May 12, 2024 14:18

gok99 requested changes May 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

asdfghjkxd commented Apr 15, 2024 •

edited

jonasongg left a comment

ckcherry23 left a comment

ckcherry23 May 11, 2024

asdfghjkxd May 12, 2024

ckcherry23 May 11, 2024

asdfghjkxd May 12, 2024

gok99 May 12, 2024

gok99 left a comment

gok99 May 12, 2024 •

edited

asdfghjkxd May 16, 2024

gok99 May 12, 2024

asdfghjkxd May 16, 2024 •

edited

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

Are you sure you want to change the base?

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

Conversation

asdfghjkxd commented Apr 15, 2024 • edited

Proposed commit message

Other information

jonasongg left a comment

Choose a reason for hiding this comment

ckcherry23 left a comment

Choose a reason for hiding this comment

ckcherry23 May 11, 2024

Choose a reason for hiding this comment

asdfghjkxd May 12, 2024

Choose a reason for hiding this comment

ckcherry23 May 11, 2024

Choose a reason for hiding this comment

asdfghjkxd May 12, 2024

Choose a reason for hiding this comment

gok99 May 12, 2024

Choose a reason for hiding this comment

gok99 left a comment

Choose a reason for hiding this comment

gok99 May 12, 2024 • edited

Choose a reason for hiding this comment

asdfghjkxd May 16, 2024

Choose a reason for hiding this comment

gok99 May 12, 2024

Choose a reason for hiding this comment

asdfghjkxd May 16, 2024 • edited

Choose a reason for hiding this comment

asdfghjkxd commented Apr 15, 2024 •

edited

gok99 May 12, 2024 •

edited

asdfghjkxd May 16, 2024 •

edited