Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Report-config.json: Support more fields #1360

Open
4 tasks
Boon-Jun opened this issue Nov 16, 2020 · 7 comments
Open
4 tasks

Report-config.json: Support more fields #1360

Boon-Jun opened this issue Nov 16, 2020 · 7 comments
Projects

Comments

@Boon-Jun
Copy link
Contributor

Boon-Jun commented Nov 16, 2020

We have added a report-config.json file that can be used for the configuration of report generation.
Right now, it only allows users to specify a report title.

We can support more fields with this config file, especially if they can be applied to all repositories during report generation.
The following are some of the fields I think we can include:

  • sinceDate
  • untilDate
  • timeZone
  • introductory text?(see discussion below)
@dcshzj
Copy link
Member

dcshzj commented Nov 17, 2020

We can also extend it to configure the introductory text as outlined in #467.

@Boon-Jun
Copy link
Contributor Author

Boon-Jun commented Nov 17, 2020

I think we have to decide to what extent should we allow the customization of the introductory text. If its just basic text replacement, then it can be done, but if the users are allowed to modify the html themselves, then it might not be suitable

@fzdy1914
Copy link
Member

@damithc Hi, Prof. Do you think a simple text will do what you need?

@damithc
Copy link
Collaborator

damithc commented Jan 19, 2021

I think it would be support basic HTML but if that's too hard, even just text is good enough. We also need to figure out where we are going to display that text, in what format.

@dcshzj
Copy link
Member

dcshzj commented Jan 25, 2021

Related task for setting sinceDate and untilDate: #634

@logical-1985516
Copy link
Contributor

Hi, may I check if this issue is resolved? If not, may I try this issue?

@ckcherry23
Copy link
Member

Hi @logical-1985516, I think this issue is not so relevant anymore as one of our ongoing PRs #2192 might make it irrelevant when merged, depending on the implementation. I'd recommend working on other issues for now, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: For contributors
Roadmap
For contributors
Development

No branches or pull requests

6 participants