Skip to content
Snippets Groups Projects

Fetch tag notes on release refresh

Merged Andrew Fontaine requested to merge afontaine/429809/fix into master
2 unresolved threads

What does this MR do and why?

A couple fixes ensuring that tag notes are available when creating a release, to ensure they are included when the user selects the relevant option.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screen_Recording_2024-01-08_at_9.30.21_AM

Screen_Recording_2024-01-08_at_9.42.01_AM

Screen_Recording_2024-01-08_at_9.42.48_AM

How to set up and validate locally

  1. Create an annotated tag for a repository
  2. Fill out the new release form using that tag
  3. refresh the page
  4. create the release
  5. Verify tag message is included in release notes.

For #429809 (closed)

Edited by Andrew Fontaine

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Andrew Fontaine changed milestone to %16.8

    changed milestone to %16.8

  • Andrew Fontaine changed the description

    changed the description

  • A deleted user added typebug label

    added typebug label

  • Contributor

    Reviewer roulette

    Changes that require review have been detected!

    Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:

    Category Reviewer Maintainer
    frontend @dzubova profile link current availability (UTC+1, 6 hours ahead of author) @cngo profile link current availability (UTC+0, 5 hours ahead of author)
    UX @veethika profile link current availability (UTC+0, 5 hours ahead of author) Maintainer review is optional for UX

    Please check reviewer's status!

    • available Reviewer is available!
    • unavailable Reviewer is unavailable!

    Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.

    To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.

    Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.

    If needed, you can retry the :repeat: danger-review job that generated this comment.

    Generated by :no_entry_sign: Danger

  • Contributor

    Bundle size analysis [beta]

    This compares changes in bundle size for entry points between the commits d273c95c and 51cea57c

    :sparkles: Special assets

    Entrypoint / Name Size before Size after Diff Diff in percent
    average 4.16 MB 4.16 MB - 0.0 %
    mainChunk 3.12 MB 3.12 MB - 0.0 %

    Note: We do not have exact data for d273c95c. So we have used data from: c6d9f787.
    The intended commit has no webpack pipeline, so we chose the last commit with one before it.

    Please look at the full report for more details


    Read more about how this report works.

    Generated by :no_entry_sign: Danger

  • Contributor

    E2E Test Result Summary

    allure-report-publisher generated test report!

    e2e-test-on-gdk: :white_check_mark: test report for 51cea57c

    expand test summary
    +------------------------------------------------------------------+
    |                          suites summary                          |
    +-------------+--------+--------+---------+-------+-------+--------+
    |             | passed | failed | skipped | flaky | total | result |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Verify      | 29     | 0      | 2       | 0     | 31    | ✅     |
    | Plan        | 52     | 0      | 2       | 0     | 54    | ✅     |
    | Create      | 45     | 0      | 17      | 0     | 62    | ✅     |
    | Monitor     | 7      | 0      | 0       | 0     | 7     | ✅     |
    | Govern      | 64     | 0      | 3       | 0     | 67    | ✅     |
    | Data Stores | 22     | 0      | 1       | 0     | 23    | ✅     |
    | Analytics   | 2      | 0      | 0       | 0     | 2     | ✅     |
    | Package     | 15     | 0      | 1       | 0     | 16    | ✅     |
    | Release     | 5      | 0      | 0       | 0     | 5     | ✅     |
    | Manage      | 0      | 0      | 1       | 0     | 1     | ➖     |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Total       | 241    | 0      | 27      | 0     | 268   | ✅     |
    +-------------+--------+--------+---------+-------+-------+--------+

    e2e-review-qa: :white_check_mark: test report for 51cea57c

    expand test summary
    +------------------------------------------------------------------+
    |                          suites summary                          |
    +-------------+--------+--------+---------+-------+-------+--------+
    |             | passed | failed | skipped | flaky | total | result |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Create      | 8      | 0      | 3       | 1     | 11    | ✅     |
    | Monitor     | 4      | 0      | 0       | 0     | 4     | ✅     |
    | Govern      | 3      | 0      | 0       | 0     | 3     | ✅     |
    | Plan        | 3      | 0      | 1       | 0     | 4     | ✅     |
    | Data Stores | 2      | 0      | 0       | 0     | 2     | ✅     |
    | Package     | 0      | 0      | 1       | 0     | 1     | ➖     |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Total       | 20     | 0      | 5       | 1     | 25    | ✅     |
    +-------------+--------+--------+---------+-------+-------+--------+
    • Author Maintainer

      @veethika can you give this a UX review?

      @sdejonge can you review the frontend?

    • Thanks @afontaine! Works as intended when using an annotated tag created from http://gdk.test:3000/flightjs/Flight/-/tags. When creating a new tag in the dropdown it doesn't appear to append the message:

      CleanShot_2024-01-09_at_17.28.48

      It also results in an error which blocks creating a release when refreshing after creating a tag within the dropdown:

      CleanShot_2024-01-09_at_17.29.36

    • @afontaine i was unable to see the message for the tag on the summary page.

      Creating a new tag with message What's displayed later
      Screenshot_2024-01-09_at_6.32.31_PM Screenshot_2024-01-09_at_6.33.06_PM

      Is there a feature flag I'm required to enable? @emilybauman can you help me understand the job here that users are looking to perform?

    • @veethika - For sure. It looks like this solves for the bug for when a user creates a release using an annotated tag, the annotated tag message does not show up on the release page when the "Include message from the annotated tag" checkbox is clicked. It should be showing up.

      The job being - Users want to be able to see the annotated tag message in the release UI.

    • Author Maintainer

      @veethika @sdejonge great find! this should be fixed now :grinning:

      The original report was for using pre-existing tags, but all scenarios should work regardless :thumbsup:

      back to you :ping_pong:

    • Thanks @afontaine! Found a console error when creating a new release without a tag. Let me know what you think!

    • It looks like this solves for the bug for when a user creates a release using an annotated tag, the annotated tag message does not show up on the release page when the "Include message from the annotated tag" checkbox is clicked. It should be showing up.

      The job being - Users want to be able to see the annotated tag message in the release UI.

      Thanks @emilybauman

      @afontaine the changes appear for me now.

      Screenshot 2024-01-10 at 10.19.53 PM.png

      A small change request for a consistent experience, instead of H3 for the header can we use the same treatment -- 14px and spacing b/w title and description to be 8px instead of 16px, as we do for evidence collection . Right now the hierarchy of information is not very clear.

      Screenshot 2024-01-10 at 10.27.56 PM.png

    • Author Maintainer

      @veethika these are part of the actual release notes of the release, so they end up in a editable markdown field (edit the release to see)

      I'm not against changing it, but would prefer to do so in a follow-up where we can understand what the formatting of them should be

    • Thanks @afontaine! Changes LGTM :white_check_mark: @markrian could you please review frontend as a maintainer? Thanks!

    • I'm not against changing it, but would prefer to do so in a follow-up where we can understand what the formatting of them should be

      Makes sense @afontaine , i'll create a follow up issue. Approving this change :tada:

    • Makes sense @afontaine , i'll create a follow up issue. Approving this change :tada:

      Thanks @veethika! Feel free to tag me in the follow up :smile:

    • Please register or sign in to reply
  • Andrew Fontaine requested review from @veethika and @sdejonge

    requested review from @veethika and @sdejonge

  • mentioned in issue #429809 (closed)

  • Andrew Fontaine added 1 commit

    added 1 commit

    • 0047b989 - Correctly include new tag notes on new release

    Compare with previous version

  • Andrew Fontaine added 1 commit

    added 1 commit

    • 7b6b93d6 - Properly rehydrate creating tag form in release

    Compare with previous version

  • Scott de Jonge
  • Andrew Fontaine added 1 commit

    added 1 commit

    • 51cea57c - Null-check release tag name on mount

    Compare with previous version

  • Scott de Jonge approved this merge request

    approved this merge request

  • Scott de Jonge requested review from @markrian and removed review request for @sdejonge

    requested review from @markrian and removed review request for @sdejonge

  • Veethika Mishra approved this merge request

    approved this merge request

  • Veethika Mishra removed review request for @veethika

    removed review request for @veethika

  • Mark Florian
    • question: Would it make sense to save the checked state of the Include message from the annotated tag. checkbox to local storage?

      Most (all?) of the other form fields seem to be stored there.

      This is existing behaviour, so no need to address it here. Just a thought.

    • Author Maintainer

      probably a good idea :slight_smile: probably...

    • Please register or sign in to reply
  • Thanks @afontaine!

    This LGTM, though I've left a few questions for you. Happy to approve as-is, as I think they can be answered/addressed post-merge.

  • Mark Florian approved this merge request

    approved this merge request

  • Mark Florian
  • Mark Florian resolved all threads

    resolved all threads

  • Mark Florian unapproved this merge request

    unapproved this merge request

  • Mark Florian approved this merge request

    approved this merge request

  • Mark Florian enabled an automatic merge when the pipeline for 241106d9 succeeds

    enabled an automatic merge when the pipeline for 241106d9 succeeds

  • merged

  • Mark Florian mentioned in commit 5fb1d093

    mentioned in commit 5fb1d093

  • mentioned in issue #438027

  • added workflowstaging label and removed workflowcanary label

  • Please register or sign in to reply
    Loading