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

georgetayqy · 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.

georgetayqy · 2024-07-15T14:29:10Z

@gok99 @damithc The feature is still being worked on at the moment (I have not finalised the precedence to read in config files/CLI arguments, and subsequently have not updated tests and test resources), but I would like to confirm with you that:

For blurbs
1. If blurbs are specified in the one-stop config file and in blurbs.md, blurbs.md is prioritised
2. If blurbs are not specified in the one-stop config file but are specified in blurbs.md, blurbs.md is prioritised
3. If blurbs are specified in the one-stop config file but are not specified in blurbs.md, the one-stop config file is prioritised
4. If blurbs are not specified at all, then neither are prioritised and BlurbMap is empty
For the precedence of configurations for the application, it is: one-stop > CLI (repos are specified in the CLI argument) > CLI (repos and settings specified in config files)

Thank you!

gok99 · 2024-07-23T14:27:03Z

@asdfghjkxd

For blurbs ...

To clarify, blurbs can be specified in one-stop config (inclusive) or blurbs.md. If the blurb is specified in only one of the two for a given repository, we take that one. If it specified in both for a given repository, we take the one in blurbs.md. So, it is possible for users to specify blurbs in both the one-stop config and blurbs.md depending on the level of detail they want.

For the precedence of configurations for the application, it is: one-stop > CLI (repos are specified in the CLI argument) > CLI (repos and settings specified in config files)

I was imagining that the one-stop config would go in the config directory and the precedence being: CLI > one-stop (+ blurbs.md) if present > csv configs (+ blurbs.md) otherwise and if present. Let me know what you think of this.

georgetayqy · 2024-08-09T06:28:33Z

Hi @gok99, thank you for the clarification!

Concerning the precedence of the configuration, I believe that your suggestions make sense; the CLI should have the greatest precedence among all other repo configurations.

Will work on this in the coming weeks!

github-actions · 2024-09-14T00:18:55Z

Hi,
We are going to mark this PR as stale because it has been inactive for the past 30 days.
If no further activity occurs within the following 7 days, it will be automatically closed so that others can take up the issue.
If you are still working on this PR, please make a follow-up commit within 7 days and leave a comment to remove the stale label.
Do let us know if you are stuck so that we can help you!'

github-actions · 2024-09-21T00:19:22Z

This PR was closed because it has been marked as stale for 7 days with no activity.
Feel free to reopen this PR if you would like to continue working on it.

github-actions · 2024-10-22T00:20:48Z

Hi,
We are going to mark this PR as stale because it has been inactive for the past 30 days.
If no further activity occurs within the following 7 days, it will be automatically closed so that others can take up the issue.
If you are still working on this PR, please make a follow-up commit within 7 days and leave a comment to remove the stale label.
Do let us know if you are stuck so that we can help you!'

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

georgetayqy mentioned this pull request Apr 15, 2024

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

Closed

1 task

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

georgetayqy 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

github-actions bot temporarily deployed to dashboard-2192 July 14, 2024 15:37 Inactive

github-actions bot temporarily deployed to docs-2192 July 14, 2024 15:37 Inactive

Implement One-Stop Config File Feature

42d167d

github-actions bot temporarily deployed to dashboard-2192 July 15, 2024 01:20 Inactive

github-actions bot temporarily deployed to docs-2192 July 15, 2024 01:20 Inactive

georgetayqy requested review from gok99 and damithc July 15, 2024 14:15

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

3e0d06b

github-actions bot temporarily deployed to dashboard-2192 August 9, 2024 06:28 Inactive

github-actions bot temporarily deployed to docs-2192 August 9, 2024 06:28 Inactive

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

d7f13b4

github-actions bot temporarily deployed to dashboard-2192 August 14, 2024 05:56 Inactive

github-actions bot temporarily deployed to docs-2192 August 14, 2024 05:56 Inactive

github-actions bot added the Stale label Sep 14, 2024

github-actions bot closed this Sep 21, 2024

gok99 reopened this Sep 21, 2024

github-actions bot temporarily deployed to dashboard-2192 September 21, 2024 07:16 Inactive

github-actions bot temporarily deployed to docs-2192 September 21, 2024 07:16 Inactive

gok99 removed the Stale label Sep 21, 2024

github-actions bot added the Stale label Oct 22, 2024

gok99 removed the Stale label Oct 22, 2024

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

1432820

github-actions bot deployed to dashboard-2192 October 30, 2024 14:33 View deployment

github-actions bot deployed to docs-2192 October 30, 2024 14:33 View deployment

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

georgetayqy commented Apr 15, 2024 •

edited

Loading

jonasongg left a comment

ckcherry23 left a comment

ckcherry23 May 11, 2024

georgetayqy May 12, 2024

ckcherry23 May 11, 2024

georgetayqy May 12, 2024

gok99 May 12, 2024

georgetayqy commented Jul 15, 2024 •

edited

Loading

gok99 commented Jul 23, 2024

georgetayqy commented Aug 9, 2024

github-actions bot commented Sep 14, 2024

github-actions bot commented Sep 21, 2024

github-actions bot commented Oct 22, 2024

[#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

georgetayqy commented Apr 15, 2024 • edited Loading

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

georgetayqy May 12, 2024

Choose a reason for hiding this comment

ckcherry23 May 11, 2024

Choose a reason for hiding this comment

georgetayqy May 12, 2024

Choose a reason for hiding this comment

gok99 May 12, 2024

Choose a reason for hiding this comment

georgetayqy commented Jul 15, 2024 • edited Loading

gok99 commented Jul 23, 2024

georgetayqy commented Aug 9, 2024

github-actions bot commented Sep 14, 2024

github-actions bot commented Sep 21, 2024

github-actions bot commented Oct 22, 2024

georgetayqy commented Apr 15, 2024 •

edited

Loading

georgetayqy commented Jul 15, 2024 •

edited

Loading