magic-modules icon indicating copy to clipboard operation
magic-modules copied to clipboard

add a subcommand into diff processor to detect missing docs

Open iyabchen opened this issue 1 year ago • 15 comments

https://github.com/hashicorp/terraform-provider-google/issues/14743 Part 1 - add missing docs command into diff-processor to detect new fields or new resource without doc. This only covers resource, NOT data sources.

  • For all field diffs, it gets the resource doc
  • Parse resource doc to get the list of existing arguments and attributes defined in the doc
    • returned as a list of string, each string represented a flattend field, eg. a.b.c
    • the parse might not be 100% accurate and not covered all corner cases. Whether a field is a nested object is determined by whether that field description contains a nested tag (some resource, eg. compute_instance params field does not have that in the description)
  • If the field is argument and not int he argument list returned by doc parser, then it's included in the result; similary for attribute
    • however, i'm not sure about the argument/attribute condition written in the code is correct or not.

Release Note Template for Downstream PRs (will be copied)


iyabchen avatar Jul 14 '24 00:07 iyabchen

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

modular-magician avatar Jul 14 '24 01:07 modular-magician

@shuyama1 This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

github-actions[bot] avatar Jul 24 '24 09:07 github-actions[bot]

Found some bugs already, need some rework.

iyabchen avatar Jul 25 '24 19:07 iyabchen

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

modular-magician avatar Aug 28 '24 22:08 modular-magician

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

modular-magician avatar Sep 14 '24 01:09 modular-magician

@GoogleCloudPlatform/terraform-team @shuyama1 This PR has been waiting for review for 2 weeks. Please take a look! Use the label disable-review-reminders to disable these notifications.

github-actions[bot] avatar Sep 17 '24 09:09 github-actions[bot]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

modular-magician avatar Sep 24 '24 19:09 modular-magician

@iyabchen, this PR is waiting for action from you. If no action is taken, this PR will be closed in 28 days.

Please address any comments or change requests, or re-request review from a core reviewer if no action is required.

Image showing the re-request review button

This notification can be disabled with the disable-automatic-closure label.

github-actions[bot] avatar Oct 07 '24 09:10 github-actions[bot]

Sorry for the delay! I just returned from vacation and am reviewing it now!

shuyama1 avatar Oct 07 '24 17:10 shuyama1

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

modular-magician avatar Oct 17 '24 18:10 modular-magician

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

Errors

google provider:

  • Failed to build branch auto-pr-11156-old

modular-magician avatar Oct 17 '24 19:10 modular-magician

/gcbrun

shuyama1 avatar Oct 18 '24 16:10 shuyama1

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

modular-magician avatar Oct 18 '24 16:10 modular-magician

@iyabchen, this PR is waiting for action from you. If no action is taken, this PR will be closed in 14 days.

Please address any comments or change requests, or re-request review from a core reviewer if no action is required.

Image showing the re-request review button

This notification can be disabled with the disable-automatic-closure label.

github-actions[bot] avatar Oct 21 '24 09:10 github-actions[bot]

@iyabchen, this PR is waiting for action from you. If no action is taken, this PR will be closed in 14 days.

Please address any comments or change requests, or re-request review from a core reviewer if no action is required.

Image showing the re-request review button

This notification can be disabled with the disable-automatic-closure label.

I apologize for the delay in my review. I'm currently in another round of detailed review. Please ignore this message. Thank you for your patience!

shuyama1 avatar Oct 21 '24 16:10 shuyama1

@iyabchen, this PR is waiting for action from you. If no action is taken, this PR will be closed in 2 weekdays.

Please address any comments or change requests, or re-request review from a core reviewer if no action is required.

Image showing the re-request review button

This notification can be disabled with the disable-automatic-closure label.

github-actions[bot] avatar Oct 31 '24 09:10 github-actions[bot]

@iyabchen, this PR is being closed due to inactivity.

github-actions[bot] avatar Nov 04 '24 09:11 github-actions[bot]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

modular-magician avatar Nov 04 '24 17:11 modular-magician

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

modular-magician avatar Nov 05 '24 02:11 modular-magician

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

modular-magician avatar Nov 05 '24 20:11 modular-magician

/gcbrun

shuyama1 avatar Jan 10 '25 19:01 shuyama1

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

modular-magician avatar Jan 10 '25 19:01 modular-magician