You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/06/23 15:58:37 UTC

[GitHub] [arrow-datafusion] mrob95 opened a new pull request, #2777: Draft: Automated generation of configs.md

mrob95 opened a new pull request, #2777:
URL: https://github.com/apache/arrow-datafusion/pull/2777

   # Which issue does this PR close?
   
   <!--
   We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
   -->
   
   Closes #2770.
   
    # Rationale for this change
   <!--
    Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
    Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.  
   -->
   
   # What changes are included in this PR?
   <!--
   There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
   -->
   
   * Added a binary - `print_config_docs` to datafusion core which generates the config markdown table and prints it.
   * Added a script to `dev` (should this be in `docs` instead?) which runs this binary to update the `configs.md` file.
   
   Posting this as a draft because I'm not sure yet what the best plan is for fully automating updates to the config documentation. I looked into `build.rs` but I'm not sure it's the right fit for this since it runs before compilation and can't import from the module it is part of.
   
   One idea I had was to run the script in a github action alongside the tests. If the action runs and there are changes to `configs.md`, it could suggest the diff on the PR and then fail. It would then be a single click to update the PR to include the changes and restart the tests. There are a few actions on the marketplace for doing this, this one looks promising: https://github.com/marketplace/actions/action-git-diff-suggestions. Open to thoughts and alternatives 🙂
   
   # Are there any user-facing changes?
   <!--
   If there are user-facing changes then we may require documentation to be updated before approving the PR.
   -->
   
   <!--
   If there are any breaking changes to public APIs, please add the `api change` label.
   -->


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-datafusion] andygrove commented on pull request #2777: Draft: Automated generation of configs.md

Posted by GitBox <gi...@apache.org>.
andygrove commented on PR #2777:
URL: https://github.com/apache/arrow-datafusion/pull/2777#issuecomment-1165573218

   Thank you @mrob95. This looks great. I tried out the changes locally. 
   
   Minor nit: could you use underscores in the script filename for consistency with the other scripts.
   
   I like the idea of CI failing if there is a diff in the generated docs but that can be handled in a separate PR.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-datafusion] xudong963 merged pull request #2777: Automated generation of configs.md

Posted by GitBox <gi...@apache.org>.
xudong963 merged PR #2777:
URL: https://github.com/apache/arrow-datafusion/pull/2777


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-datafusion] mrob95 commented on pull request #2777: Automated generation of configs.md

Posted by GitBox <gi...@apache.org>.
mrob95 commented on PR #2777:
URL: https://github.com/apache/arrow-datafusion/pull/2777#issuecomment-1165645976

   > Minor nit: could you use underscores in the script filename for consistency with the other scripts.
   Done 👍 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org