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.

Sign up for GitHub

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

Jump to bottom

Make all config options optional #156

Closed
dcastro opened this issue Sep 23, 2022 · 1 comment · Fixed by #159 or #172
Closed

Make all config options optional #156

dcastro opened this issue Sep 23, 2022 · 1 comment · Fixed by #159 or #172
Assignees
@Sereja313
Milestone
0.2.1

Comments

@dcastro
Copy link
Member

dcastro commented Sep 23, 2022

Clarification and motivation

In #126 we made the ignoreRefs option required (to match the other options).

However, in a subsequent discussion, it was pointed out that having it optional is better for backwards-compatibility and to help users migrate to newer xrefcheck versions.

Let's make all the config options optional.

Acceptance criteria

  • All config options are optional
@dcastro dcastro added this to the 0.2.1 milestone Sep 23, 2022
@Sereja313 Sereja313 self-assigned this Sep 23, 2022
Sereja313 added a commit that referenced this issue Sep 23, 2022
@Sereja313
[#156] Make all config options optional
a99005d 
Problem: In #126 we made the `ignoreRefs` option required (to match the
other options). However, having it optional is better for
backwards-compatibility and to help users migrate to newer xrefcheck
versions.

Solution: Make all config options optional.
@Sereja313 Sereja313 mentioned this issue Sep 23, 2022
Merged
11 tasks
dcastro added a commit that referenced this issue Sep 24, 2022
@dcastro
Merge pull request #159 from serokell/Sereja313/#156-make-all-config-…
e4fc5d5 
…options-optional

[#156] Make all config options optional
@dcastro
Copy link
Member Author

dcastro commented Sep 25, 2022

Now that this is merged, I think we should go over the multiple test config files in tests/golden, and trim them so that only the relevant options are present (see example: #152 (comment)). @Sereja313 can you please open another PR linking again to this issue?

@dcastro dcastro reopened this Sep 25, 2022
Sereja313 added a commit that referenced this issue Sep 25, 2022
@Sereja313
[#156] Trim redundant config fields from test configs
24ea5a9 
Problem: In #159 we made all config fields optional. Now we can trim
redundant fields from test configs.

Solution: Trim redundant config fields. Also slightly refactor
`overrideVerify` function to make it more readable.
@Sereja313 Sereja313 mentioned this issue Sep 25, 2022
Merged
12 tasks
Sereja313 added a commit that referenced this issue Sep 28, 2022
@Sereja313
[#156] Trim redundant config fields from test configs
8b8d8ee 
Problem: In #159 we made all config fields optional. Now we can trim
redundant fields from test configs.

Solution: Trim redundant config fields. Also slightly refactor
`overrideVerify` function to make it more readable.
Sereja313 added a commit that referenced this issue Oct 4, 2022
@Sereja313
[#156] Trim redundant config fields from test configs
2bcbfa1 
Problem: In #159 we made all config fields optional. Now we can trim
redundant fields from test configs.

Solution: Trim redundant config fields. Also slightly refactor
`overrideVerify` function to make it more readable.
Sereja313 added a commit that referenced this issue Oct 4, 2022
@Sereja313
Merge pull request #172 from serokell/Sereja313/#156-trim-redundant-c…
02f7aae 
…onfig-fields

[#156] Trim redundant config fields from test configs
@Martoon-00 Martoon-00 mentioned this issue Nov 30, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Sereja313 Sereja313

Labels
None yet
Projects
None yet
Milestone
0.2.1
2 participants
@dcastro @Sereja313