Skip to content
This repository has been archived by the owner on Dec 15, 2021. It is now read-only.

[JENKINS-31153] Rename Workflow to Pipeline #296

Merged
merged 13 commits into from
Jan 15, 2016

Conversation

recena
Copy link
Contributor

@recena recena commented Jan 11, 2016

JENKINS-31153

Screenshots

jenkins-31153_1

jenkins-31153_2

@reviewbybees

@ghost
Copy link

ghost commented Jan 11, 2016

This pull request originates from a CloudBees employee. At CloudBees, we require that all pull requests be reviewed by other CloudBees employees before we seek to have the change accepted. If you want to learn more about our process please see this explanation.

@oleg-nenashev
Copy link
Member

👎 on this pull request till there is an agreement with the community on renaming.

@oleg-nenashev
Copy link
Member

Just to clarify:

  • There are plugins with similar names: (Build Pipeline, Delivery Pipeline, OpenShift Pipeline)
  • The renaming causes conflicts and may be very confusing
  • At least owners of potentially impacted plugins should agree with the renaming IMHO

@recena recena changed the title [JENKINS-31153] All the display names the user interface [JENKINS-31153] Rename Workflow to Pipeline. All the display names the UI Jan 11, 2016
@recena
Copy link
Contributor Author

recena commented Jan 11, 2016

@oleg-nenashev I'm maintainer of one of them 😄

@oleg-nenashev
Copy link
Member

Removed the @reviewbybees bug according to the inputs

@@ -127,7 +127,7 @@ public void userDefinedGlobalVariable() throws Exception {
WorkflowJob p = jenkins.createProject(WorkflowJob.class, "p");

p.setDefinition(new CpsFlowDefinition(
"acmeVar.hello('Workflow');" +
"acmeVar.hello('Pipeline');" +
Copy link
Member

Choose a reason for hiding this comment

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

OK…not user-visible text, does not really matter, but fine.

@jglick
Copy link
Member

jglick commented Jan 13, 2016

🐛 missing updates to README.md, TUTORIAL.md, etc.

🐛 missing updates to plugin display names in pom.xmls.

@recena
Copy link
Contributor Author

recena commented Jan 13, 2016

@jglick I wanted to separate it in two differents PR:

  • Source code modifications related to UI
  • Documentation and Maven configuration

Do you agree?

@jglick
Copy link
Member

jglick commented Jan 13, 2016

Do you agree?

No. Certainly the pom.xml updates are logically part of this: they are source code modifications related to the UI (in this case that shown in Plugin Manager).

And if you are going to file a renaming PR in the repo, you might as well just finish and rename the usages in Markdown files too.

@recena
Copy link
Contributor Author

recena commented Jan 13, 2016

I don't know why I ask it...

@@ -271,15 +271,15 @@ You may override the new `guessBrowser`, so that scripts do not need to specify

If you have a commit trigger, generally an `UnprotectedRootAction` which schedules builds, it will need a few changes.
Use `SCMTriggerItem` rather than the deprecated `SCMedItem`; use `SCMTriggerItem.SCMTriggerItems.asSCMTriggerItem` rather than checking `instanceof`.
Its `getSCMs` method can be used to enumerate configured SCMs, which in the case of a workflow will be those run in the last build.
Its `getSCMs` method can be used to enumerate configured SCMs, which in the case of a Pipeline will be those run in the last build.
Copy link
Member

Choose a reason for hiding this comment

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

This one would be lowercase IMO

@@ -25,5 +25,5 @@ THE SOFTWARE.

<?jelly escape-by-default='true'?>
<div>
Defines a new job type for workflows and provides their generic user interface.
Defines a new job type for pipelines and provides their generic user interface.
Copy link
Contributor

Choose a reason for hiding this comment

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

+caps

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But, we have decided to use pipelines when mentions to generic pipelines. Right?

Copy link
Contributor

Choose a reason for hiding this comment

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

@recena but ... this is specific to the Pipeline plugin, no? "define a new job type for pipelines..."

Copy link
Contributor

Choose a reason for hiding this comment

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

I think Manuel is right here: Pipeline creates pipelines. At least it's consistent with the naming scheme from Workflow. Maybe everywhere we talk about pipeline-as-created-by-Pipeline we call it a "Pipeline job" or slightly more clunky "pipeline-job".

Copy link
Contributor

Choose a reason for hiding this comment

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

@kwhetstone I'm indifferent on a many of these. Though it could really go either way, in this case we're not defining a job type to create an arbitrary pipeline, we're specifically creating a Jenkins Pipeline.
Although "Pipeline creates pipelines", referring to specific items that the plugin creates, uses, or is otherwise directly tied to it should be referred to as "Pipeline(s)", even though they might also describe a generic pipeline. I didn't bug or ant this, though; it is not that important. :)

@kzantow
Copy link
Contributor

kzantow commented Jan 13, 2016

@recena Agree with Jesse, add pom.xml to this, and it looks good.

@recena
Copy link
Contributor Author

recena commented Jan 13, 2016

@kzantow It seems @jglick is always right ;)

@recena
Copy link
Contributor Author

recena commented Jan 13, 2016

@jglick

[INFO] Pipeline: Parent ................................... SUCCESS [  9.038 s]
[INFO] Pipeline: Step API ................................. SUCCESS [ 14.232 s]
[INFO] Pipeline: API ...................................... SUCCESS [  9.126 s]
[INFO] Pipeline: Execution Support ........................ SUCCESS [ 10.100 s]
[INFO] Pipeline: Basic Steps .............................. SUCCESS [  8.097 s]
[INFO] Pipeline: Durable Task Step ........................ SUCCESS [  7.136 s]
[INFO] Pipeline: SCM Step ................................. SUCCESS [  9.484 s]
[INFO] Pipeline: Groovy CPS Execution ..................... SUCCESS [ 27.030 s]
[INFO] Pipeline: Global Shared Library for CPS pipeline ... SUCCESS [  8.269 s]
[INFO] Pipeline: Job ...................................... SUCCESS [  7.291 s]
[INFO] Pipeline ........................................... SUCCESS [ 13.808 s]
[INFO] Pipeline: Multibranch .............................. SUCCESS [  8.356 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 02:15 min
[INFO] Finished at: 2016-01-13T20:17:49+01:00
[INFO] Final Memory: 101M/552M
[INFO] ------------------------------------------------------------------------

To me it is weird to see Pipeline alone but...

@kzantow
Copy link
Contributor

kzantow commented Jan 13, 2016

🐝 looks good to me afaik, without self-grepping the code :)

@recena
Copy link
Contributor Author

recena commented Jan 13, 2016

@kzantow I have to dive deeply but it is a first approach

@recena
Copy link
Contributor Author

recena commented Jan 13, 2016

jenkins-uc

@kwhetstone
Copy link
Contributor

@recena I agree that it's weird seeing "Pipeline" by itself, but it must have been like that for "Workflow" when it was first released as well! 🐝

Again dependencies will be pulled in automatically, including all the OSS plugins.

# News & questions

* [Changelog](CHANGES.md)
* [jenkins-workflow tag](http://stackoverflow.com/tags/jenkins-workflow) on StackOverflow
* [jenkins-pipeline tag](http://stackoverflow.com/tags/jenkins-pipeline) on StackOverflow
Copy link
Member

Choose a reason for hiding this comment

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

🐛 do not change this now—there is no such tag yet. If and when that rename happens, I will update this line of course.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The initial idea was to do the StackOverflow renaming too.

@recena
Copy link
Contributor Author

recena commented Jan 14, 2016

Note that examples like this were updated with new output format.

@jglick
Copy link
Member

jglick commented Jan 15, 2016

🐝

@jglick
Copy link
Member

jglick commented Jan 15, 2016

Actually one more request: plugin summaries (<description>/index.jelly) and the TopLevelItemDescriptor summary view should explain parenthetically that the plugin was formerly known as Workflow. Otherwise existing users upgrading could be pretty confused.

* [JIRA](https://issues.jenkins-ci.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+JENKINS+AND+resolution+%3D+Unresolved+AND+%28component+%3D+workflow-plugin+OR+labels+in+%28workflow%29%29+ORDER+BY+component+ASC,+key+DESC&mode=hide) (file issues in the `workflow-plugin` component, or other components with the `workflow` label)
* [User list discussions](https://groups.google.com/forum/#!topicsearchin/jenkinsci-users/workflow) (mention `workflow` in the subject)
* [#JenkinsWorkflow](https://twitter.com/hashtag/JenkinsWorkflow) on Twitter
* [JIRA](https://issues.jenkins-ci.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+JENKINS+AND+resolution+%3D+Unresolved+AND+%28component+%3D+workflow-plugin+OR+labels+in+%28workflow%29%29+ORDER+BY+component+ASC,+key+DESC&mode=hide) (file issues in the `workflow-plugin` component, or other components with the `pipeline` label)
Copy link
Member

Choose a reason for hiding this comment

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

🐛 for now we are still using the workflow label (TBD about its rename). Anyway the text now does not match the query URL.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok

@jglick
Copy link
Member

jglick commented Jan 15, 2016

🐝

@@ -32,7 +32,7 @@
</parent>
<artifactId>workflow-aggregator</artifactId>
<packaging>hpi</packaging>
<name>Workflow: Aggregator</name>
<name>Pipeline (formerly known as Workflow)</name>
Copy link
Member

Choose a reason for hiding this comment

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

This does not seem right to me, but that is a 🐜

@svanoort
Copy link
Member

🐝 - I have mixed feelings about having/not having parenthetical descriptions of renames, but this change seems fine.

@recena
Copy link
Contributor Author

recena commented Jan 15, 2016

@svanoort This will be only along a short time.

@recena
Copy link
Contributor Author

recena commented Jan 15, 2016

@reviewbybees done

jglick added a commit that referenced this pull request Jan 15, 2016
[JENKINS-31153] Rename Workflow to Pipeline
@jglick jglick merged commit 118b89e into jenkinsci:master Jan 15, 2016
@recena recena deleted the JENKINS-31153 branch January 15, 2016 22:05
jglick added a commit that referenced this pull request Jan 15, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants