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

Jenkins step docs should not show as changed files after build

    XMLWordPrintable

Details

    • Improvement
    • Status: Done (View Workflow)
    • Minor
    • Resolution: Fixed
    • core

    Description

      Currently the pipeline-examples are generated based on the HEAD of master in the pipeline-examples repository. This means whenever someone builds they will very often get changed files due to pipeline examples having new commits.

      We should use a git submodule link to lock the commit used to generate pipeline-examples content to a known commit and then either manually update this commit or automatically update it during the website pipeline. This will remove this noise from most contributors builds and allow us to control what example content is published to jenkins.io.

      Attachments

        Activity

          rtyler R. Tyler Croy added a comment -

          bitwiseman actually I strongly disagree with git-submodules(1) here. That is a guaranteed way for jenkins.io to be completely out of date, and I am not signing up to baby-sit updates from pipeline-examples.

          If there's a problem with "out of date" files, then we can just remove them from the git tree and let the generated files get dumped into the working directory.

          rtyler R. Tyler Croy added a comment - bitwiseman actually I strongly disagree with git-submodules(1) here. That is a guaranteed way for jenkins.io to be completely out of date, and I am not signing up to baby-sit updates from pipeline-examples. If there's a problem with "out of date" files, then we can just remove them from the git tree and let the generated files get dumped into the working directory.
          bitwiseman Liam Newman added a comment - - edited

          (Turns out it wasn't examples but pipeline step docs. Changed title.)

          My main point was that users building locally shouldn't be seeing changed files due to this.
          I'll be fine with this as long as we "git ignore" the files so that don't appear as changed after the build. See https://github.com/jenkins-infra/jenkins.io/pull/359.

          bitwiseman Liam Newman added a comment - - edited (Turns out it wasn't examples but pipeline step docs. Changed title.) My main point was that users building locally shouldn't be seeing changed files due to this. I'll be fine with this as long as we "git ignore" the files so that don't appear as changed after the build. See https://github.com/jenkins-infra/jenkins.io/pull/359 .
          rtyler R. Tyler Croy added a comment -

          Feel empowered to submit changes along those lines; I think it might make more sense to remove the files rather than git-ignore them though

          rtyler R. Tyler Croy added a comment - Feel empowered to submit changes along those lines; I think it might make more sense to remove the files rather than git-ignore them though
          bitwiseman Liam Newman added a comment -

          rtyler
          See the linked PR. Removed and git ignored.

          bitwiseman Liam Newman added a comment - rtyler See the linked PR. Removed and git ignored.

          People

            bitwiseman Liam Newman
            bitwiseman Liam Newman
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: