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

[#156] Make all config options optional #159

Merged
merged 1 commit into from
Sep 24, 2022
Merged

[#156] Make all config options optional #159

merged 1 commit into from
Sep 24, 2022

Conversation

Sereja313
Copy link
Member

@Sereja313 Sereja313 commented Sep 23, 2022 •
edited
Loading

Description

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.

Related issue(s)

Fixes #156

✅ Checklist for your Pull Request

Ideally a PR has all of the checkmarks set.

If something in this list is irrelevant to your PR, you should still set this
checkmark indicating that you are sure it is dealt with (be that by irrelevance).

Related changes (conditional)

  • Tests

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from
      silently reappearing again.

  • Documentation

    • I checked whether I should update the docs and did so if necessary:

  • Public contracts

    • Any modifications of public contracts comply with the Evolution
      of Public Contracts       policy.
    • I added an entry to the changelog if my changes are visible to the users
      and
    • provided a migration guide for breaking changes if possible

Stylistic guide (mandatory)

✓ Release Checklist

  • I updated the version number in package.yaml.
  • I updated the changelog and moved everything
    under the "Unreleased" section to a new section for this release version.
  • (After merging) I created a new entry in the releases page,
    with a summary of all user-facing changes.
    • I made sure a tag was created using the format vX.Y.Z

@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.
@dcastro dcastro merged commit e4fc5d5 into master Sep 24, 2022
@dcastro dcastro deleted the Sereja313/#156-make-all-config-options-optional branch September 24, 2022 07:30
@dcastro dcastro mentioned this pull request Sep 25, 2022
Merged
8 tasks
Sereja313 added a commit that referenced this pull request 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 pull request Sep 25, 2022
Merged
12 tasks
Sereja313 added a commit that referenced this pull request 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 Sereja313 mentioned this pull request Sep 28, 2022
Closed
Sereja313 added a commit that referenced this pull request Sep 29, 2022
@Sereja313
[#180] Make flavor a required parameter
5f6195b 
Problem: As of #159 we made all config fields optional. However, it
makes sense to make the `flavor` field mandatory, as it affects
correctness and the user must make a choice here.

Solution: Make `flavor` a required parameter.
Sereja313 added a commit that referenced this pull request Sep 29, 2022
@Sereja313
[#180] Make flavor a required parameter
680ace2 
Problem: As of #159 we made all config fields optional. However, it
makes sense to make the `flavor` field mandatory, as it affects
correctness and the user must make a choice here.

Solution: Make `flavor` a required parameter.
@Sereja313 Sereja313 mentioned this pull request Sep 29, 2022
Merged
13 tasks
Sereja313 added a commit that referenced this pull request Sep 29, 2022
@Sereja313
[#180] Make flavor a required parameter
723e122 
Problem: As of #159 we made all config fields optional. However, it
makes sense to make the `flavor` field mandatory, as it affects
correctness and the user must make a choice here.

Solution: Make `flavor` a required parameter.
Sereja313 added a commit that referenced this pull request 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 pull request Oct 4, 2022
@Sereja313
[#180] Make flavor a required parameter
2b17bb0 
Problem: As of #159 we made all config fields optional. However, it
makes sense to make the `flavor` field mandatory, as it affects
correctness and the user must make a choice here.

Solution: Make `flavor` a required parameter.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dcastro dcastro dcastro approved these changes

@Sorokin-Anton Sorokin-Anton Awaiting requested review from Sorokin-Anton

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make all config options optional
2 participants
@Sereja313 @dcastro