cli: Use more explicit naming for auth subcommands
ClosedPublic
Actions

Authored by anlambert on Oct 22 2020, 5:11 PM.

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Commits

rDWCLI4dc69f4cccba: cli: Use more explicit naming for auth subcommands

Summary

Rename login subcommand to generate-token and logout subcommand
to revoke-token.

Diff Detail

Repository

rDWCLI Web client

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

anlambert created this revision.Oct 22 2020, 5:11 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptOct 22 2020, 5:11 PM

Build is green

Patch application report for D4336 (id=15342)

Rebasing onto 0d962ea355...

Current branch diff-target is up to date.

Changes applied before test

commit 4f24ee3be34a89e7f275b4ca4129220c6b8963b6
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Thu Oct 22 17:10:02 2020 +0200

    cli: Use more explicit naming for auth subcommands
    
    Rename login subcommand to generate-token and logout subcommand
    to revoke-token.

See https://jenkins.softwareheritage.org/job/DWCLI/job/tests-on-diff/25/ for more details.

Harbormaster completed remote builds in B16569: Diff 15342.Oct 22 2020, 5:12 PM

looks good to me

now, i don't know if:

we need to send an email about that change to notify users
add an alias with the old name and add a deprecation notice on those old names

thoughts?

This revision is now accepted and ready to land.Oct 22 2020, 5:15 PM

In D4336#107905, @ardumont wrote:

looks good to me

now, i don't know if:

we need to send an email about that change to notify users

add an alias with the old name and add a deprecation notice on those old names

thoughts?

I think adding aliases with deprecation warnings is the better option here as no client code would be broken.

Update: Ensure backward compatibility by keeping old command names as aliases and marking them as deprecated.

Build is green

Patch application report for D4336 (id=15349)

Rebasing onto 0d962ea355...

Current branch diff-target is up to date.

Changes applied before test

commit 4dc69f4cccbacd833c598eec0888be467df34095
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Thu Oct 22 17:10:02 2020 +0200

    cli: Use more explicit naming for auth subcommands
    
    Rename login subcommand to generate-token and logout subcommand
    to revoke-token.

See https://jenkins.softwareheritage.org/job/DWCLI/job/tests-on-diff/26/ for more details.

Harbormaster completed remote builds in B16576: Diff 15349.Oct 22 2020, 6:07 PM

cool!

Closed by commit rDWCLI4dc69f4cccba: cli: Use more explicit naming for auth subcommands (authored by anlambert). · Explain WhyOct 22 2020, 6:07 PM

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDWCLI4dc69f4cccba: cli: Use more explicit naming for auth subcommands.