view release on metacpan or  search on metacpan

lib/sqitch-rework.pod  view on Meta::CPAN

=item C<--requires>

Name of a change that is required by the new change. May be specified multiple
times. See L<sqitchchanges> for the various ways in which changes can be
specified.

=item C<-x>

=item C<--conflicts>

Name of a change that conflicts with the new change. May be specified multiple
times. See L<sqitchchanges> for the various ways in which changes can be
specified.

=item C<-a>

=item C<--all>

Rework the change in all plans in the project. Cannot be mixed with target,
engine, or plan file name arguments; doing so will result in an error. Useful
for multi-plan projects in which changes should be kept in sync. Overrides the
value of the C<add.all> configuration; use C<--no-all> to override a true
C<add.all> configuration.

=item C<-n>

=item C<--note>

A brief note describing the purpose of the reworking. The note will be
attached to the change as a comment. Multiple invocations will be concatenated
together as separate paragraphs.

For you Git folks out there, C<-m> also works.

=item C<-e>

=item C<--edit>

=item C<--open-editor>

Open the generated change scripts in an editor.

=item C<--no-edit>

=item C<--no-open-editor>

Do not open the change scripts in an editor. Useful when L<C<rework.open_editor>>
is true.

=item C<--plan-file>

=item C<-f>

Path to the deployment plan file. Overrides target, engine, and core
configuration values. Defaults to F<$top_dir/sqitch.plan>.

=back

=head1 Examples

Rework a change in a project and be prompted for a note.

  sqitch rework widgets

Rework a change and specify the note.

  sqitch rework sprockets --note 'Reworks the sprockets view.'

Rework a change that requires the C<users> change from earlier in the plan.

  sqitch rework contacts --requires users -n 'Reworks the contacts view.'

Rework a change that requires multiple changes, including the change named
C<extract> from a completely different Sqitch project named C<utilities>:

  sqitch rework coffee -r users -r utilities:extract -n 'Mmmmm...coffee!'

Rework a change only to the plan used by the C<vertica> engine in a project:

  sqitch rework --change logs vertica -n 'Reworks the logs view in Vertica.'

Rework a change in two plans in a project, and generate the scripts only for
those plans:

  sqitch rework -a coolfunctions sqlite.plan pg.plan -n 'Reworks functions.'

=head1 Configuration Variables

=over

=item C<rework.all>

Rework the change to all the plans in the project. Useful for multi-plan projects
in which changes should be kept in sync. May be overridden by C<--all>,
C<--no-all>, or target, engine, and plan file name arguments.

=item C<rework.open_editor>

Boolean indicating if the rework command should spawn an editor after
generating change scripts.  When true, equivalent to passing C<--edit>.
Defaults off.

=back

=head1 Sqitch

Part of the L<sqitch> suite.