It needs to be documented somewhere that users need to run:

drush switch:profile old_profile new_profile

As there's no README, placing this on the project page is fine.

CommentFileSizeAuthor
#8 profile_switcher-add_documentation-3121337-9.patch2.19 KBcolan

Comments

colan created an issue. See original summary.

colan’s picture

colan
he/him
Primary language English
Location Toronto 🇨🇦
commented
Status: Active » Needs review
tim-diels’s picture

tim-diels
He/Him
Primary language Dutch
Location Belgium 🇧🇪
commented

The drush command only accepts one argument so the drush command is

drush switch:profile new_profile

colan’s picture

colan
he/him
Primary language English
Location Toronto 🇨🇦
commented

I believe that's incorrect. I used two as per the code in function profile_switcher_drush_command(). As you can see, there are two arguments there. It's possible that profile_to_delete isn't being used, however.

This confusion is exactly why all of this needs to be documented. :)

joachim’s picture

joachim commented
Status: Needs review » Postponed (maintainer needs more info) 
Drush 7:

function drush_profile_switcher_switch_profile($profile_to_install = '') {

Drush 9:

  public function profile($profile_to_install) {

The documentation here is wrong:

    'arguments' => [
      'profile_name' => 'The profile to activate',
      'profile_to_delete' => 'The profile to disable',
    ],

I've fixed that, so this can possibly be closed?

Does the Drush help for the command provide enough detail?

colan’s picture

colan
he/him
Primary language English
Location Toronto 🇨🇦
commented
Status: Postponed (maintainer needs more info) » Needs work

Possibly, but folks won't *know* about the Drush command if it's not documented. Either add a README or put info on the project page.

The command that worked for me, above, was Drush 8 (currently required for Aegir). If it runs differently for different versions of Drush, that also needs to be documented.

As there's no usage documentation whatsoever, I didn't even realize it was a Drush command. I was searching through the Web UI trying to figure out how to run the thing. I had to dig into the code to figure out it was only a Drush command. Users shouldn't have to do that.

Say it's a Drush command, and tell folks how to run it.

joachim’s picture

joachim commented
Status: Needs work » Active

I've changed the project page to start with:

> This module provides a Drush command to switch between install profiles found in /profile directory.

I'll take a patch for a README :)

colan’s picture

colan
he/him
Primary language English
Location Toronto 🇨🇦
commented
Priority: Critical » Major
Status: Active » Needs review
StatusFileSize
new profile_switcher-add_documentation-3121337-9.patch2.19 KB

Thanks! Here's the patch.

colan’s picture

colan
he/him
Primary language English
Location Toronto 🇨🇦
commented
colan’s picture

colan
he/him
Primary language English
Location Toronto 🇨🇦
commented

  • joachim committed e11a782 on 8.x-1.x authored by colan 
    Issue #3121337 by colan: Fixed missing README.
joachim’s picture

joachim commented
Status: Needs review » Fixed

Committed! Thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.