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

Update the Changelogs for the 1.0 Releases #1122

Merged
merged 7 commits into from
Oct 15, 2024

Conversation

coltonhurst
Copy link
Member

๐Ÿ“” Objective

Update the changelogs for the 1.0 releases of bitwarden and bws.

โฐ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

๐Ÿฆฎ Reviewer guidelines

  • ๐Ÿ‘ (:+1:) or similar for great changes
  • ๐Ÿ“ (:memo:) or โ„น๏ธ (:information_source:) for notes or general info
  • โ“ (:question:) for questions
  • ๐Ÿค” (:thinking:) or ๐Ÿ’ญ (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • ๐ŸŽจ (:art:) for suggestions / improvements
  • โŒ (:x:) or โš ๏ธ (:warning:) for more significant problems or concerns needing attention
  • ๐ŸŒฑ (:seedling:) or โ™ป๏ธ (:recycle:) for future improvements or indications of technical debt
  • โ› (:pick:) for minor or nitpick changes

@coltonhurst coltonhurst self-assigned this Oct 9, 2024
@coltonhurst coltonhurst requested a review from a team as a code owner October 9, 2024 16:09
Copy link
Contributor

github-actions bot commented Oct 9, 2024

Logo
Checkmarx One โ€“ Scan Summary & Details โ€“ f5f5133c-a46d-4e61-a545-ef9469819781

No New Or Fixed Issues Found

Copy link

codecov bot commented Oct 9, 2024

Codecov Report

All modified and coverable lines are covered by tests โœ…

Project coverage is 58.17%. Comparing base (8b44f55) to head (7d9aea0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1122   +/-   ##
=======================================
  Coverage   58.17%   58.17%           
=======================================
  Files         197      197           
  Lines       13587    13587           
=======================================
  Hits         7904     7904           
  Misses       5683     5683           

โ˜” View full report in Codecov by Sentry.
๐Ÿ“ข Have feedback on the report? Share it here.

Copy link
Contributor

@tangowithfoxtrot tangowithfoxtrot left a comment

Choose a reason for hiding this comment

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

Just one thing that I caught in the bws changelog:

crates/bws/CHANGELOG.md Show resolved Hide resolved
### Added

- The ability to edit unassigned secrets with direct permissions. (#906)
- A way to opt out of state by default with the new state_opt_out key (#930)
Copy link
Member

Choose a reason for hiding this comment

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

Should we link to any documentation of this?

Suggested change
- A way to opt out of state by default with the new state_opt_out key (#930)
- A way to opt out of state with the new `state_opt_out` setting (#930)

Copy link
Member Author

@coltonhurst coltonhurst Oct 10, 2024

Choose a reason for hiding this comment

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

Great idea. I've brought this up with the docs team, if we can get docs made for this I can update it!

I don't think we need to hold up this PR for that, but totally fine if you want to hold it.

Copy link
Member

Choose a reason for hiding this comment

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

I think we should change the phrasing since opt out of state by default is vague, do we by default opt out of state? But we don't have to link it to our docs.

Copy link
Member Author

Choose a reason for hiding this comment

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

No, we currently use state by default. state_opt_out allows you to opt out of using state files. We use state files by default to help prevent the rate limit errors the user would normally run into.

Copy link
Member

@Hinton Hinton Oct 11, 2024

Choose a reason for hiding this comment

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

I'm aware, but the phrasing of "A way to opt out of state by default" lacks clarity. And can be interpreted as the default behaviour is to opt out.

Since it's a behaviour change you could put the state_opt_out next to the changed item instead.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, I see what you mean. Updated in 28090fc, let me know what you think. Thanks!

dani-garcia
dani-garcia previously approved these changes Oct 14, 2024
@coltonhurst coltonhurst merged commit 8aea2e9 into main Oct 15, 2024
98 of 99 checks passed
@coltonhurst coltonhurst deleted the ChangelogUpdateFor1.0Release branch October 15, 2024 15:41
coltonhurst added a commit that referenced this pull request Oct 17, 2024
## ๐Ÿ“” Objective

As discussed in PR #1122, add a
link to our docs about the opt out change.

## โฐ Reminders before review

- Contributor guidelines followed
- All formatters and local linters executed and passed
- Written new unit and / or integration tests where applicable
- Protected functional changes with optionality (feature flags)
- Used internationalization (i18n) for all UI strings
- CI builds passed
- Communicated to DevOps any deployment requirements
- Updated any necessary documentation (Confluence, contributing docs) or
informed the documentation
  team

## ๐Ÿฆฎ Reviewer guidelines

<!-- Suggested interactions but feel free to use (or not) as you desire!
-->

- ๐Ÿ‘ (`:+1:`) or similar for great changes
- ๐Ÿ“ (`:memo:`) or โ„น๏ธ (`:information_source:`) for notes or general info
- โ“ (`:question:`) for questions
- ๐Ÿค” (`:thinking:`) or ๐Ÿ’ญ (`:thought_balloon:`) for more open inquiry
that's not quite a confirmed
  issue and could potentially benefit from discussion
- ๐ŸŽจ (`:art:`) for suggestions / improvements
- โŒ (`:x:`) or โš ๏ธ (`:warning:`) for more significant problems or
concerns needing attention
- ๐ŸŒฑ (`:seedling:`) or โ™ป๏ธ (`:recycle:`) for future improvements or
indications of technical debt
- โ› (`:pick:`) for minor or nitpick changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants