• Icon: Improvement Improvement
    • Resolution: Fixed
    • Icon: Minor Minor
    • gitlab-plugin
    • None

      (edited for formatting)

      There have been some not-so-obvious changes in the 1.2.x family of plugins. The two I've noticed are:

      • Shifting to environment variables instead of build parameters
      • moving of the GitLab integration checkbox to a post-build step.

      Each of these are reflected in the "how to" of the README but are buried amongst the normal documentation without identifying them as a change from the previous version. This makes it hard to detect by a human being who has read the documentation several times to detect. The CHANGELOG.md does not explicitly mention these changes.

      I recommend that migration guides are introduced whenever there is a change which may impact user jobs. This can be a section within the main README, but may be better as its own document or wiki page to keep the documentation for new users "clean".

      This will make it more obvious what actions users may need to take to move from one version to the next.

      Workaround: Run diffs on README.md whenever there is a version bump to find out what configuration changes have been made.

            omorillo Oscar Salvador Morillo Victoria
            crussell52 Chris Russell
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: