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

Change --dryRun semantics and add dedicated --resolve #48

Merged
merged 2 commits into from
Oct 13, 2020
Merged

Conversation

g-pavlov
Copy link
Contributor

@g-pavlov g-pavlov commented Oct 12, 2020

What this PR does / why we need it:
The current dryRun shows only the resolve documentation structure, but it does not reveal details about how it will be serialized.
This PR changes the behavior as follows.

  • dry-run flag
    A command run with dry-run option will now use the writers.DryRunWriter provided for that purpose both for node and
    resource writing. The writer implements the writers.Writer printing the resulting file/folder hierarchy to stdout, plus statistics
    about the files processing (e.g. links):
    dev
      doc
        aws_provider.md
          Links stats: 0 link rewrites
        gardener
          README.md
            Links stats: 85 link rewrites
              ./concepts/apiserver -> concepts/apiserver.md
              ./concepts/apiserver_admission_plugins -> concepts/apiserver_admission_plugins.md
              ./concepts/controller-manager -> concepts/controller-manager.md
    ...
    Build finished in 2.432423 seconds
    
  • resolve flag
    The resolve flag prints out the resolved documentations structure, expanding nodeSelector nodes to node hierarchies and removing the selectors afterwards. When resolve is used with nodeSelector it is useful for quickly scafolding structures from existing file hierarchies.

Release note:

Introduced a new `--resolve` flag. It prints to the standard output the resolved documentation structure, expanding `nodeSelector` elements to node hierarchies. When `resolve` is used with `nodeSelector` it is useful for quickly scafolding structures from existing file hierarchies.
Changed the `--dry-run` flag behavior. When running docforge with `--dry-run` it will do a full scale build as instructed, but without writing down the result. Instead, it will print to the standard output the projected file/folder structure with statistics for the processing of each document in the structure and total processing time.

@g-pavlov g-pavlov added component/documentation Gardener Documentation kind/technical-debt Something that is only solved on the surface, but requires more (re)work to be done properly labels Oct 12, 2020
@gardener-robot gardener-robot added needs/review Needs review size/s Size of pull request is small (see gardener-robot robot/bots/size.py) labels Oct 12, 2020
@gardener-robot-ci-1 gardener-robot-ci-1 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 12, 2020
@gardener-robot-ci-2 gardener-robot-ci-2 added needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Oct 12, 2020
@gardener-robot gardener-robot added size/l Size of pull request is large (see gardener-robot robot/bots/size.py) needs/second-opinion Needs second review by someone else and removed size/s Size of pull request is small (see gardener-robot robot/bots/size.py) labels Oct 12, 2020
@gardener-robot-ci-3 gardener-robot-ci-3 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 12, 2020
@gardener-robot-ci-1 gardener-robot-ci-1 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 12, 2020
@gardener-robot-ci-1 gardener-robot-ci-1 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Oct 13, 2020
@gardener-robot gardener-robot added size/m Size of pull request is medium (see gardener-robot robot/bots/size.py) and removed size/l Size of pull request is large (see gardener-robot robot/bots/size.py) labels Oct 13, 2020
@gardener-robot-ci-1 gardener-robot-ci-1 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 13, 2020
@gardener-robot-ci-2 gardener-robot-ci-2 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 13, 2020
@gardener-robot gardener-robot added kind/api-change API change with impact on API users size/l Size of pull request is large (see gardener-robot robot/bots/size.py) and removed size/m Size of pull request is medium (see gardener-robot robot/bots/size.py) labels Oct 13, 2020
@gardener-robot-ci-1 gardener-robot-ci-1 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 13, 2020
@gardener-robot-ci-3 gardener-robot-ci-3 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 13, 2020
@gardener-robot-ci-1 gardener-robot-ci-1 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 13, 2020
@gardener-robot-ci-1 gardener-robot-ci-1 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 13, 2020
@gardener-robot-ci-2 gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Oct 13, 2020
@g-pavlov g-pavlov changed the title End-to-end dryRun Change --dryRun semantics and add dedicated --resolve Oct 13, 2020
@gardener-robot-ci-3 gardener-robot-ci-3 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 13, 2020
@g-pavlov g-pavlov merged commit 4ebfe11 into master Oct 13, 2020
@gardener-robot-ci-3 gardener-robot-ci-3 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 13, 2020
@g-pavlov g-pavlov deleted the dry-run branch October 13, 2020 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/documentation Gardener Documentation kind/api-change API change with impact on API users kind/technical-debt Something that is only solved on the surface, but requires more (re)work to be done properly needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) needs/review Needs review needs/second-opinion Needs second review by someone else size/l Size of pull request is large (see gardener-robot robot/bots/size.py)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants