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

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

Open
wants to merge 33 commits into
base: master
Choose a base branch
from

Conversation

lyuanww
Copy link
Contributor

@lyuanww lyuanww commented Feb 14, 2025

Part of #2161

Proposed commit message

Implement One-Stop Config File for Code Portfolio.

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.
  • Implement MVP version from previous PR
  • Handle optional fields and error handling
  • Add filesizelimit field
  • Implement blurb overriding priority
  • Implement configuration overriding priority logic
  • Refactor default instances out of some classes
  • Fix and add tests for code coverage
  • Update docs

Behaviour

Configuration files priority:
CLI (--repos flag) -> new YAML file (if present and correctly formatted and repos section present) -> CSV files

Blurbs priority:
Take blurbs either from blurbs field in YAML file or from blurbs.md. If both present, take the one in blurbs.md.

Credit

Referenced and branched off from #2192

georgetayqy and others added 24 commits April 15, 2024 14:32
@github-actions github-actions bot requested a deployment to dashboard-2299 February 14, 2025 15:56 Abandoned
@github-actions github-actions bot requested a deployment to docs-2299 February 14, 2025 15:56 Abandoned
@github-actions github-actions bot requested a deployment to dashboard-2299 February 18, 2025 03:48 Abandoned
@github-actions github-actions bot requested a deployment to docs-2299 February 18, 2025 03:48 Abandoned
@github-actions github-actions bot requested a deployment to dashboard-2299 February 20, 2025 18:15 Abandoned
@github-actions github-actions bot requested a deployment to docs-2299 February 20, 2025 18:15 Abandoned
@github-actions github-actions bot requested a deployment to dashboard-2299 February 21, 2025 18:31 Abandoned
@github-actions github-actions bot requested a deployment to docs-2299 February 21, 2025 18:31 Abandoned
@lyuanww lyuanww changed the title Implement one stop config file v2 [#2161] One-Stop Config File for Code Portfolio Feb 21, 2025
@github-actions github-actions bot requested a deployment to dashboard-2299 February 21, 2025 19:30 Abandoned
@github-actions github-actions bot requested a deployment to docs-2299 February 21, 2025 19:30 Abandoned
@github-actions github-actions bot requested a deployment to dashboard-2299 February 22, 2025 16:08 Abandoned
@github-actions github-actions bot requested a deployment to docs-2299 February 22, 2025 16:08 Abandoned
@github-actions github-actions bot requested a deployment to dashboard-2299 February 22, 2025 16:37 Abandoned
@github-actions github-actions bot requested a deployment to docs-2299 February 22, 2025 16:37 Abandoned
@github-actions github-actions bot requested a deployment to dashboard-2299 February 22, 2025 16:58 Abandoned
@github-actions github-actions bot requested a deployment to docs-2299 February 22, 2025 16:58 Abandoned
@lyuanww lyuanww marked this pull request as ready for review February 22, 2025 17:07
@lyuanww lyuanww requested a review from a team February 22, 2025 17:07
@lyuanww lyuanww self-assigned this Feb 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants