Add copy-to-clipboard button to the build console output #8960

anhcraft · 2024-02-14T15:34:03Z

The build's output currently lacks a copy-to-clipboard button. This is a small QoL improvement to quickly copy the console output. The button also supports progressive text output.
The copy button only supports text via the attribute text. Therefore, this PR also introduces another parameter ref to refer to the target element using the id. Compared to the text approach, it has some advantages: reduces page size, supports formatted logging output and can work across UI components.

Testing done

Manually testing

Before:

After:

Proposed changelog entries

Add "copy to clipboard" button to the build console output.

Submitter checklist

Tasks

Give feedback

The Jira issue, if it exists, is well-described.

The Jira issue, if it exists, is well-described.
Options
Successfully updated the issue's project

There was an error updating the issue's project
The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see [examples](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml)). Fill in the **Proposed upgrade guidelines** section only if there are breaking changes or changes that may require extra steps from users during upgrade.

The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
Options
Successfully updated the issue's project

There was an error updating the issue's project
There is automated testing or an explanation as to why this change has no tests.

There is automated testing or an explanation as to why this change has no tests.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New public classes, fields, and methods are annotated with `@Restricted` or have `@since TODO` Javadocs, as appropriate.

New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New deprecations are annotated with `@Deprecated(since = "TODO")` or `@Deprecated(forRemoval = true, since = "TODO")`, if applicable.

New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New or substantially changed JavaScript is not defined inline and does not call `eval` to ease future introduction of Content Security Policy (CSP) directives (see [documentation](https://www.jenkins.io/doc/developer/security/csp/)).

New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
Options
Successfully updated the issue's project

There was an error updating the issue's project
For dependency updates, there are links to external changelogs and, if possible, full differentials.

For dependency updates, there are links to external changelogs and, if possible, full differentials.
Options
Successfully updated the issue's project

There was an error updating the issue's project
For new APIs and extension points, there is a link to at least one consumer.

For new APIs and extension points, there is a link to at least one consumer.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

Desired reviewers

@jenkinsci/core-pr-reviewers

Before the changes are marked as ready-for-merge:

Maintainer checklist

Tasks

Give feedback

There are at least two (2) approvals for the pull request and no outstanding requests for change.

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.

Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Changelog entries in the pull request title and/or **Proposed changelog entries** are accurate, human-readable, and in the imperative mood.

Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Proper changelog labels are set so that the changelog can be generated automatically.

Proper changelog labels are set so that the changelog can be generated automatically.
Options
Successfully updated the issue's project

There was an error updating the issue's project
If the change needs additional upgrade steps from users, the `upgrade-guide-needed` label is set and there is a **Proposed upgrade guidelines** section in the pull request title (see [example](https://github.com/jenkinsci/jenkins/pull/4387)).

If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
Options
Successfully updated the issue's project

There was an error updating the issue's project
If it would make sense to backport the change to LTS, a Jira issue must exist, be a _Bug_ or _Improvement_, and be labeled as `lts-candidate` to be considered (see [query](https://issues.jenkins.io/issues/?filter=12146)).

If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

welcome · 2024-02-14T15:34:07Z

Yay, your first pull request towards Jenkins core was created successfully! Thank you so much!

A contributor will provide feedback soon. Meanwhile, you can join the chats and community forums to connect with other Jenkins users, developers, and maintainers.

MarkEWaite · 2024-02-15T15:56:32Z

Thanks for the pull request @anhcraft . When you performed the testing, did you confirm that the copied text was inserted into the clipboard? When I've tested these types of pull requests in the past, I needed to use an HTTPS URL to check that the correct text was placed on the clipboard.

timja · 2024-02-15T16:14:59Z

I needed to use an HTTPS URL to check that the correct text was placed on the clipboard.

It should be a secure context, which is localhost or https url

anhcraft · 2024-02-15T17:47:57Z

Thanks for the pull request @anhcraft . When you performed the testing, did you confirm that the copied text was inserted into the clipboard? When I've tested these types of pull requests in the past, I needed to use an HTTPS URL to check that the correct text was placed on the clipboard.

It worked for me when running locally. My PR does not change the secure-context check at all.
Related PRs: #7665 #8554

anhcraft · 2024-02-15T18:14:54Z

Confirmed it works for existing copy buttons (script console, agent page )

lemeurherve · 2024-02-15T19:36:07Z

Would it be possible to put the copy button in the top right corner of the logs like it's done on GitHub amongst others?

Having it alongside titles gives the false impression that's their content which will be copied, it's not obvious at first look these buttons concern the logs block below.

Exemple of a block with a copy button on the top right corner.


Another line.


The end.

MarkEWaite · 2024-02-16T01:54:17Z

Would it be possible to put the copy button in the top right corner of the logs like it's done on GitHub amongst others?

I think that is a reasonable request for another pull request, since the placement that @anhcraft has selected is consistent with the placement of other copy buttons in Jenkins.

core/src/main/resources/lib/layout/copyButton.jelly

NotMyFault

Thanks!

core/src/main/resources/lib/layout/copyButton.jelly

Co-authored-by: Alexander Brandes <brandes.alexander@web.de>

timja

/label ready-for-merge

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

welcome · 2024-03-05T20:01:28Z

Congratulations on getting your very first Jenkins core pull request merged 🎉🥳

This is a fantastic achievement, and we're thrilled to have you as part of our community! Thank you for your valuable input, and we look forward to seeing more of your contributions in the future!

We would like to invite you to join the community chats and forums to meet other Jenkins contributors 😊
Don't forget to check out the participation page to learn more about how to contribute to Jenkins.

anhcraft added 2 commits February 14, 2024 21:51

Add copy-to-clipboard button to the build console output

bfefd4e

Fix copy button did not work with progressive output

3776a93

NotMyFault added rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted needs-security-review Awaiting review by a security team member labels Feb 14, 2024

NotMyFault requested a review from a team February 14, 2024 22:03

Use getElementById instead of querySelector

fa7f7a9

yaroslavafenkin added security-approved @jenkinsci/core-security-review reviewed this PR for security issues and removed needs-security-review Awaiting review by a security team member labels Feb 16, 2024

NotMyFault reviewed Feb 16, 2024

View reviewed changes

core/src/main/resources/lib/layout/copyButton.jelly Outdated Show resolved Hide resolved

Update copyButton documentation

cacc43d

anhcraft requested a review from NotMyFault February 18, 2024 04:42

NotMyFault approved these changes Feb 18, 2024

View reviewed changes

core/src/main/resources/lib/layout/copyButton.jelly Show resolved Hide resolved

NotMyFault requested a review from a team February 18, 2024 15:50

anhcraft and others added 2 commits February 19, 2024 09:10

Update core/src/main/resources/lib/layout/copyButton.jelly

6d5f820

Co-authored-by: Alexander Brandes <brandes.alexander@web.de>

Merge branch 'master' into console-copy-button

ac0f8a5

NotMyFault requested a review from a team February 20, 2024 14:21

NotMyFault requested a review from timja March 4, 2024 14:47

timja approved these changes Mar 4, 2024

View reviewed changes

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Mar 4, 2024

NotMyFault merged commit b0a251a into jenkinsci:master Mar 5, 2024
17 checks passed

daniel-beck mentioned this pull request Apr 17, 2024

Add download option to 'Console output', move 'View as plain text' and 'Copy' buttons to app bar #9169

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add copy-to-clipboard button to the build console output #8960

Add copy-to-clipboard button to the build console output #8960

anhcraft commented Feb 14, 2024 •

edited by MarkEWaite

Tasks

Tasks

welcome bot commented Feb 14, 2024

MarkEWaite commented Feb 15, 2024

timja commented Feb 15, 2024 •

edited

anhcraft commented Feb 15, 2024

anhcraft commented Feb 15, 2024

lemeurherve commented Feb 15, 2024 •

edited

MarkEWaite commented Feb 16, 2024

NotMyFault left a comment

timja left a comment

welcome bot commented Mar 5, 2024

Add copy-to-clipboard button to the build console output #8960

Add copy-to-clipboard button to the build console output #8960

Conversation

anhcraft commented Feb 14, 2024 • edited by MarkEWaite

Testing done

Proposed changelog entries

Submitter checklist

Tasks

Desired reviewers

Maintainer checklist

Tasks

welcome bot commented Feb 14, 2024

MarkEWaite commented Feb 15, 2024

timja commented Feb 15, 2024 • edited

anhcraft commented Feb 15, 2024

anhcraft commented Feb 15, 2024

lemeurherve commented Feb 15, 2024 • edited

MarkEWaite commented Feb 16, 2024

NotMyFault left a comment

Choose a reason for hiding this comment

timja left a comment

Choose a reason for hiding this comment

welcome bot commented Mar 5, 2024

anhcraft commented Feb 14, 2024 •

edited by MarkEWaite

timja commented Feb 15, 2024 •

edited

lemeurherve commented Feb 15, 2024 •

edited