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

[#170] [#119] Reorganize top-level config keys #175

Merged
merged 1 commit into from
Oct 25, 2022

Conversation

Sereja313
Copy link
Member

@Sereja313 Sereja313 commented Sep 27, 2022

Description

Problem: At the moment, the config yaml is organized in 3 top-level keys: traversal, verification and scanners. However, the distinction between the "traversal" and the "verification" stages is not relevant to the user. This is entirely an internal concern.

Solution: Reorganize yaml config options under exclusions, networking and scanners.

Related issue(s)

Fixes #170
Fixes #119

✅ 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 edited the auto-release.
    • Change the tag and title using the format vX.Y.Z.
    • Write a summary of all user-facing changes.
    • Deselect the "This is a pre-release" checkbox at the bottom.
  • (After merging) I updated xrefcheck-action.

@Sereja313 Sereja313 force-pushed the Sereja313/#170-reorganize-config-keys branch from 5faded0 to 6e4891e Compare September 27, 2022 08:08
@Sereja313 Sereja313 linked an issue Sep 27, 2022 that may be closed by this pull request
@Sereja313 Sereja313 force-pushed the Sereja313/#156-trim-redundant-config-fields branch from 24ea5a9 to 8b8d8ee Compare September 28, 2022 07:06
@Sereja313 Sereja313 force-pushed the Sereja313/#170-reorganize-config-keys branch 2 times, most recently from a5fae5b to 108f9d3 Compare September 28, 2022 07:33
@Sereja313 Sereja313 force-pushed the Sereja313/#156-trim-redundant-config-fields branch from 8b8d8ee to 2bcbfa1 Compare October 4, 2022 12:50
Base automatically changed from Sereja313/#156-trim-redundant-config-fields to master October 4, 2022 12:52
Copy link
Member

@dcastro dcastro left a comment

Choose a reason for hiding this comment

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

Approved, but please don't merge until 0.2.2 is released.

src/Xrefcheck/CLI.hs Outdated Show resolved Hide resolved
@dcastro dcastro mentioned this pull request Oct 21, 2022
@dcastro dcastro changed the title [#170] Reorganize top-level config keys [#170] [#119] Reorganize top-level config keys Oct 21, 2022
@dcastro
Copy link
Member

dcastro commented Oct 25, 2022

This can now be rebased & merged

Problem: At the moment, the config yaml is organized in 3 top-level
keys: `traversal`, `verification` and `scanners`. However, the distinction
between the "traversal" and the "verification" stages is not relevant
to the user. This is entirely an internal concern.

Solution: Reorganize yaml config options under `exclusions`, `networking`
and `scanners`.
@Sereja313 Sereja313 force-pushed the Sereja313/#170-reorganize-config-keys branch from cb4e935 to 013457a Compare October 25, 2022 21:39
@Sereja313 Sereja313 merged commit 6b9b81e into master Oct 25, 2022
@Sereja313 Sereja313 deleted the Sereja313/#170-reorganize-config-keys branch October 25, 2022 21:52
@int-index int-index mentioned this pull request Dec 27, 2024
5 tasks
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.

Reorganize top-level config keys Traversal vs Scanning
3 participants