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

Inclusive naming changes #149

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

CatherineKiiru
Copy link

@CatherineKiiru CatherineKiiru commented May 3, 2022

Inclusive naming changes

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests - that demonstrates feature works or fixes the issue

@CatherineKiiru CatherineKiiru changed the title s) Inclusive naming changes May 3, 2022
Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

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

Minor improvements

@@ -57,7 +57,7 @@ Release date: 2019-10-22
> **NOTE**: To revert to previous release behavior, pass the system property
> `org.jenkinsci.plugins.durabletask.BourneShellScript.FORCE_SHELL_WRAPPER=true` to the Java command line used to start Jenkins.

- Update ssh-slaves ([PR \#100](https://github.com/jenkinsci/durable-task-plugin/pull/100))
- Update ssh-agents ([PR \#100](https://github.com/jenkinsci/durable-task-plugin/pull/100))
Copy link
Contributor

Choose a reason for hiding this comment

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

Slightly different for linguistic reasons. The previous entry used the "plugin ID" which is not well known to users and is unchanging even for inclusive naming. Let's use the plugin name rather than the identifier

Suggested change
- Update ssh-agents ([PR \#100](https://github.com/jenkinsci/durable-task-plugin/pull/100))
- Update SSH Build Agents plugin ([PR \#100](https://github.com/jenkinsci/durable-task-plugin/pull/100))

@@ -89,7 +89,7 @@ Release date: 2019-07-05
be used to enable zombie-reaping in docker containers (--init) or kubernetes pods (shared
process namespaces).
- Bugfix: Use `sh` to run shell scripts rather than attempting to
use the absolute path to the default shell from the master on
use the absolute path to the default shell from the Controller on
Copy link
Contributor

Choose a reason for hiding this comment

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

Lower case rather than upper case inside the sentence

Suggested change
use the absolute path to the default shell from the Controller on
use the absolute path to the default shell from the controller on

@@ -338,7 +338,7 @@ Release date: 2015-12-03
Release date: 2015-04-08

- Do not kill a one-shot agent merely because a flyweight task
happened to run on it (rather than on master as usual). Works around
happened to run on it (rather than on the Controller as usual). Works around
Copy link
Contributor

Choose a reason for hiding this comment

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

Lower case

Suggested change
happened to run on it (rather than on the Controller as usual). Works around
happened to run on it (rather than on the controller as usual). Works around

@@ -58,7 +58,7 @@
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>ssh-slaves</artifactId>
<artifactId>ssh-agents</artifactId>
Copy link
Contributor

Choose a reason for hiding this comment

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

That's an identifier, needs to remain the same

Suggested change
<artifactId>ssh-agents</artifactId>
<artifactId>ssh-slaves</artifactId>

@@ -268,7 +268,7 @@ private List<String> scriptLauncherCmd(ShellController c, FilePath ws, @CheckFor

/*package*/ static final class ShellController extends FileMonitoringController {

/** Last time we checked the timestamp, in nanoseconds on the master. */
/** Last time we checked the timestamp, in nanoseconds on the Controller. */
Copy link
Contributor

Choose a reason for hiding this comment

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

Lower case

Suggested change
/** Last time we checked the timestamp, in nanoseconds on the Controller. */
/** Last time we checked the timestamp, in nanoseconds on the controller. */

@@ -640,7 +640,7 @@ private static class Watcher implements Runnable {
Timer.get().schedule(this, 100, TimeUnit.MILLISECONDS);
}
} catch (Exception x) {
// note that LOGGER here is going to the agent log, not master log
// note that LOGGER here is going to the agent log, not the Controller log
Copy link
Contributor

Choose a reason for hiding this comment

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

Lower case

Suggested change
// note that LOGGER here is going to the agent log, not the Controller log
// note that LOGGER here is going to the agent log, not the controller log

@@ -34,7 +34,7 @@

/**
* A remote handler which may be sent to an agent and handle process output and results.
* If it needs to communicate with the master, you may use {@link VirtualChannel#export}.
* If it needs to communicate with the Controller, you may use {@link VirtualChannel#export}.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* If it needs to communicate with the Controller, you may use {@link VirtualChannel#export}.
* If it needs to communicate with the controller, you may use {@link VirtualChannel#export}.

I assume the same here

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.

3 participants