Uploaded image for project: 'Jenkins Website'
  1. Jenkins Website
  2. WEBSITE-389

Link to or somehow incorporate explanation and use cases for @NonCPS

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: To Do (View Workflow)
    • Priority: Minor
    • Resolution: Unresolved
    • Component/s: content
    • Labels:
      None
    • Similar Issues:

      Description

      See JENKINS-45904 - we should really have an explanation for @NonCPS and guide to when you need to use it in the docs. There's https://github.com/jenkinsci/workflow-cps-plugin/blob/master/README.md#technical-design, but it's not the most clear, so probably makes more sense to write something fresh.

        Attachments

          Issue Links

            Activity

            Hide
            jglick Jesse Glick added a comment -

            Yes this should be covered somehow on jenkins.io. In general, there is a lot of content originally hosted on GitHub which did not get picked up when Pipeline docs on jenkins.io were written. I understand that the format and tone were not appropriate for the new site but the current documentation is simply incomplete in many important respects.

            Show
            jglick Jesse Glick added a comment - Yes this should be covered somehow on jenkins.io. In general, there is a lot of content originally hosted on GitHub which did not get picked up when Pipeline docs on jenkins.io were written. I understand that the format and tone were not appropriate for the new site but the current documentation is simply incomplete in many important respects.
            Hide
            multani Jonathan Ballet added a comment -

            Coming onto this ticket as I've been bitten by JENKINS-45904.

            there is a lot of content originally hosted on GitHub

            Jesse Glick Besides the README in https://github.com/jenkinsci/workflow-cps-plugin#technical-design, did you have any other specific documents in mind? I'd be interested to know more actually!

            Show
            multani Jonathan Ballet added a comment - Coming onto this ticket as I've been bitten by JENKINS-45904 . there is a lot of content originally hosted on GitHub Jesse Glick Besides the README in https://github.com/jenkinsci/workflow-cps-plugin#technical-design , did you have any other specific documents in mind? I'd be interested to know more actually!
            Hide
            jglick Jesse Glick added a comment -

            Runtime diagnostics from JENKINS-31314 include a new wiki page (in progress).

            Show
            jglick Jesse Glick added a comment - Runtime diagnostics from JENKINS-31314 include a new wiki page (in progress).

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              abayer Andrew Bayer
              Votes:
              2 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated: