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-16533] Rename files to indicate they belong to Password Manager #1231

Merged
merged 8 commits into from
Jan 14, 2025

Conversation

KatherineInCode
Copy link
Contributor

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-16533

📔 Objective

As part of the plan to merge the Authenticator repository into this one, we'll want to avoid filename conflicts. This moves various YML files out of the way by specifying that they're for Password Manager, so that the Authenticator ones will be able to sit next to them fine once the merge is done.

⏰ 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

Copy link

codecov bot commented Dec 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.43%. Comparing base (793fa70) to head (21b7a59).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1231   +/-   ##
=======================================
  Coverage   89.43%   89.43%           
=======================================
  Files         725      725           
  Lines       45821    45821           
=======================================
  Hits        40979    40979           
  Misses       4842     4842           

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

Copy link
Contributor

github-actions bot commented Dec 30, 2024

Logo
Checkmarx One – Scan Summary & Details4b98531d-8248-407d-88d0-682c939c7b85

Great job, no security vulnerabilities found in this Pull Request

@KatherineInCode KatherineInCode marked this pull request as ready for review December 30, 2024 22:17
Comment on lines 358 to 359
yq -i '.settings.MARKETING_VERSION = "${{ steps.version_info.outputs.version_name }}"' 'project_passwordmanager.yml'
yq -i '.settings.CURRENT_PROJECT_VERSION = "${{ steps.version_info.outputs.version_number }}"' 'project_passwordmanager.yml'
Copy link
Member

@fedemkr fedemkr Dec 31, 2024

Choose a reason for hiding this comment

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

🤔 As far as I can see we're using hyphen - instead of underscore _ to separate words in the filenames for yml like crowdin-pull.yml or github-release.yml. Is there a reason to change to underscore for the new ones in this PR?
🤔 Also what do you think of using the abbreviate version of Password Manager => PM? So then we can use BWA for the authenticator.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Both of those seem very reasonable to me; when I wrote the PM section of the Action Plan I was patterning off of what @vvolkgang had done for the BWA section, but I think hyphens and abbreviations is a good way to go. Álison, what do you think?

If we do this with hyphens and abbreviations, I can get the Action Plan updated to match.

Copy link
Member

Choose a reason for hiding this comment

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

That just happened to be the original name of .license_plist.yml. We can rename them all to use - while at it.

Let's go with the shorter names. We'll scrap some / all instances of these later while merging files.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Awesome, I'll get the Action Plan updated accordingly, and then make the change here

Copy link
Member

Choose a reason for hiding this comment

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

🤔 Should this file also be renamed to use hyphen as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hm. I was going off of all of the scripts (except download-artifacts.sh) using underscores. I'm not sure if updating all of them to also be hyphens would be in the scope of this change, though? If we want to do that?

(I think it's reasonable for us to do that at this point, to match everything else; it's more a question of whether this is the best place for that or not)

Copy link
Member

Choose a reason for hiding this comment

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

I'm fine to leave that for another PR if you feel it's out of the scope of this PR, no problem at all. Approving as is 👍

@KatherineInCode KatherineInCode merged commit bcaab3f into main Jan 14, 2025
9 checks passed
@KatherineInCode KatherineInCode deleted the pm-16533/rename-files branch January 14, 2025 16:04
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.

3 participants