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

Add option to format Jupyter Notebooks files in GitHub Actions #3282

Merged
merged 5 commits into from
Sep 26, 2022
Merged

Add option to format Jupyter Notebooks files in GitHub Actions #3282

merged 5 commits into from
Sep 26, 2022

Commits on Sep 26, 2022

  1. Support formatting Jupyter Notebooks in GH Action 

    To run the formatter on Jupyter Notebooks, Black must be installed
with an extra dependency (`black[jupyter]`). This commit adds an
optional argument to install Black with this dependency when using the
official GitHub Action [1]. To enable the formatter on Jupyter
Notebooks, just add `jupyter: true` as an argument. Feature requested
at [2].

[1]: https://black.readthedocs.io/en/stable/integrations/github_actions.html
[2]: #3280

Signed-off-by: Antonio Ossa Guerra <[email protected]>
    @aaossa
    aaossa committed Sep 26, 2022
    Configuration menu
    Copy the full SHA
    1e9db8c View commit details
    Browse the repository at this point in the history

  2. Update CHANGES.md 

    Include the new GitHub Action optional argument as a change

Signed-off-by: Antonio Ossa Guerra <[email protected]>
    @aaossa
    aaossa committed Sep 26, 2022
    Configuration menu
    Copy the full SHA
    dd9de60 View commit details
    Browse the repository at this point in the history

  3. Add new jupyter option to documentation 

    This new argument enables the installation of the `jupyter` extra when
using the Black GitHub Action. The new behaviour is exaplained, and
the option is included in the provided example

Signed-off-by: Antonio Ossa Guerra <[email protected]>
    @aaossa
    aaossa committed Sep 26, 2022
    Configuration menu
    Copy the full SHA
    f8dd5da View commit details
    Browse the repository at this point in the history

  4. Add Antonio Ossa Guerra as contributor 

    After the contribution to improve the GitHub Action supported by Black

Signed-off-by: Antonio Ossa Guerra <[email protected]>
    @aaossa
    aaossa committed Sep 26, 2022
    Configuration menu
    Copy the full SHA
    d28bd55 View commit details
    Browse the repository at this point in the history

  5. Mention jupyter option in changelog and typo fix

    @ichard26
    ichard26 committed Sep 26, 2022
    Configuration menu
    Copy the full SHA
    6f66160 View commit details
    Browse the repository at this point in the history