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

Allow plural and singular tool naming for test, log, doc #3363

Merged
merged 6 commits into from
Dec 6, 2023

Conversation

merelcht
Copy link
Member

Description

Fixes #3339

Development notes

Updated the mapping from shorthand tool name to number to include plural as well as singular naming for the testing, logging and documentation options. Data, lint, pyspark, and viz don't make sense in other forms.

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
@merelcht merelcht self-assigned this Nov 29, 2023
@merelcht merelcht linked an issue Nov 29, 2023 that may be closed by this pull request
Copy link
Contributor

@SajidAlamQB SajidAlamQB left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@AhdraMeraliQB
Copy link
Contributor

An edge case more than anything else, but as well as the duplicates in the message we also see duplicates in the pyproject.toml - is this something we want to handle on our side?

kedro new --tools=test,tests,log,logs,doc,docs

image

@merelcht
Copy link
Member Author

An edge case more than anything else, but as well as the duplicates in the message we also see duplicates in the pyproject.toml - is this something we want to handle on our side?

kedro new --tools=test,tests,log,logs,doc,docs

@AhdraMeraliQB this was captured here #3333 by @ankatiyar . It was also happening before this change.

Copy link
Contributor

@AhdraMeraliQB AhdraMeraliQB left a comment

Choose a reason for hiding this comment

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

Looks good to me! Suggested a change but it's nothing blocking 😄

tests/framework/cli/test_starters.py Outdated Show resolved Hide resolved
merelcht and others added 2 commits December 6, 2023 09:36
Co-authored-by: Ahdra Merali <90615669+AhdraMeraliQB@users.noreply.github.com>
Signed-off-by: Merel Theisen <49397448+merelcht@users.noreply.github.com>
@merelcht merelcht enabled auto-merge (squash) December 6, 2023 09:37
@merelcht merelcht merged commit 36d0c1b into develop Dec 6, 2023
30 checks passed
@merelcht merelcht deleted the flexible-plural-singular-tools branch December 6, 2023 10:04
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.

Improving shortname handling of --addons flag
3 participants