Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PM-7349] Update snap description with new URL to help docs #8703

Merged
merged 2 commits into from
Apr 23, 2024

Conversation

trmartin4
Copy link
Member

@trmartin4 trmartin4 commented Apr 11, 2024

Type of change

- [ ] Bug fix
- [ ] New feature development
- [ ] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
- [X] Build/deploy pipeline (DevOps)
- [ ] Other

Objective

In #8672 we added a description to the snap build to indicate that we need users to manually connect the password-manager-service. This turned out to be longer than the 128-character max on the description.

We shortened it temporarily in #8687 but have since added help docs and this is adjusting the description to link to the docs.

Before you submit

  • Please add unit tests where it makes sense to do so (encouraged but not required)
  • If this change requires a documentation update - notify the documentation team
  • If this change has particular deployment requirements - notify the DevOps team
  • Ensure that all UI additions follow WCAG AA requirements

@github-actions github-actions bot added the needs-qa Marks a PR as requiring QA approval label Apr 11, 2024
@trmartin4 trmartin4 changed the title Updated snap summary with new URL to help docs. [PM-7349] Update snap summary with new URL to help docs Apr 11, 2024
@trmartin4 trmartin4 marked this pull request as ready for review April 11, 2024 17:08
@trmartin4 trmartin4 requested a review from jlf0dev April 11, 2024 17:08
@jlf0dev
Copy link
Member

jlf0dev commented Apr 11, 2024

I have a feeling we're using the wrong tag here. There's a description override key in the electron builder documentation that we might want to consider using. It doesn't seem to have the same character limits.

Copy link

codecov bot commented Apr 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 27.62%. Comparing base (c2b91d2) to head (6223f64).
Report is 53 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8703      +/-   ##
==========================================
+ Coverage   27.20%   27.62%   +0.42%     
==========================================
  Files        2339     2356      +17     
  Lines       68263    68972     +709     
  Branches    12748    12924     +176     
==========================================
+ Hits        18570    19055     +485     
- Misses      48297    48488     +191     
- Partials     1396     1429      +33     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

github-actions bot commented Apr 11, 2024

Logo
Checkmarx One – Scan Summary & Details6bdf1f68-545d-4122-9648-494f18edab17

New Issues

Severity Issue Source File / Package Checkmarx Insight
MEDIUM Angular_Improper_Type_Pipe_Usage /apps/web/src/app/billing/shared/adjust-storage.component.html: 27 Attack Vector

@trmartin4
Copy link
Member Author

@jlf0dev I've updated to have a short summary and your original description, with the inclusion of the new help URL as well.

@trmartin4 trmartin4 changed the title [PM-7349] Update snap summary with new URL to help docs [PM-7349] Update snap description with new URL to help docs Apr 18, 2024
Copy link
Member

@jlf0dev jlf0dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks!

@trmartin4 trmartin4 merged commit e4ebf4a into main Apr 23, 2024
34 of 36 checks passed
@trmartin4 trmartin4 deleted the auth/pm-7349/update-snap-description branch April 23, 2024 13:18
trmartin4 added a commit that referenced this pull request May 6, 2024
trmartin4 added a commit that referenced this pull request May 6, 2024
* Updated snap summary with new URL to help docs.

* Updated to use summary and description.

(cherry picked from commit e4ebf4a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-qa Marks a PR as requiring QA approval
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants