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

Improve config JSON readability and composability #889

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

blizzardc0der
Copy link
Contributor

@blizzardc0der blizzardc0der commented Apr 26, 2024

Description

Currently, I've improved the readability and composability of the JSON file by applying the changes mentioned in the issue.

We now have "name" and "config" field for an individual store and scheduler JSON for setting its name and its configurations.
And "stores" and "schedulers" field now accepts array instead of map.

Fixes #834

Type of change

  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to
    not work as expected)
  • This change requires a documentation update

Checklist

  • Updated documentation if needed
  • Tests added/amended
  • bazel test //... passes locally
  • PR is contained in a single commit, using git amend see some docs

This change is Reviewable

@blizzardc0der
Copy link
Contributor Author

I hope you to review this. @MarcusSorealheis , @allada , @aaronmondal , @adam-singer
Thanks.

Copy link
Collaborator

@MarcusSorealheis MarcusSorealheis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Blizzard for returning to contribute. I personally do not think this PR is ready for review. Can you take a look at the output

Reviewable status: 0 of 1 LGTMs obtained, and pending CI: Bazel Dev / ubuntu-22.04, Remote / large-ubuntu-22.04, asan / ubuntu-22.04, docker-compose-compiles-nativelink (20.04), docker-compose-compiles-nativelink (22.04), macos-13, ubuntu-22.04, and 1 discussions need to be resolved


deployment-examples/docker-compose/scheduler.json line 16 at r2 (raw file):

  }, {
    "name": "GRPC_LOCAL_AC_STORE",
    "config": {

instead of config, we should be using options. The whole file is a config.

@blizzardc0der
Copy link
Contributor Author

Well, @allada wanted that to be config instead of options.
See this discussion below.
#834

What would be the correct wording for that?
I want you to clear that. Thanks. cc: @allada , @MarcusSorealheis

@blizzardc0der blizzardc0der force-pushed the improve-config-json branch 2 times, most recently from 27db3c6 to 3ae01f4 Compare May 1, 2024 13:02
We now have "name" and "options" field for an individual store and
scheduler JSON for setting its name and its configurations.
And "stores" and "schedulers" field now accepts array instead of map.
Copy link
Contributor Author

@blizzardc0der blizzardc0der left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 1 LGTMs obtained, and pending CI: Analyze (javascript-typescript), Analyze (python), Bazel Dev / ubuntu-22.04, Cargo Dev / macos-13, Cargo Dev / ubuntu-22.04, Local / ubuntu-22.04, Publish image, Publish nativelink-worker-lre-cc, Remote / large-ubuntu-22.04, asan / ubuntu-22.04, docker-compose-compiles-nativelink (20.04), docker-compose-compiles-nativelink (22.04), integration-tests (20.04), integration-tests (22.04), macos-13, pre-commit-checks, ubuntu-20.04 / stable, ubuntu-22.04, ubuntu-22.04 / stable, vale, windows-2022 / stable, and 1 discussions need to be resolved


deployment-examples/docker-compose/scheduler.json line 16 at r2 (raw file):

Previously, MarcusSorealheis (Marcus Eagan) wrote…

instead of config, we should be using options. The whole file is a config.

Done.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Discussion] How to Improve the Readability and Composability of the NativeLink Config JSON part 1
3 participants