Skip to content

Conversation

@SavPhill
Copy link
Contributor

@SavPhill SavPhill commented Jul 12, 2023

When generating REST API Keys, they are hidden using an ellipsis generated by …

This is unorthadox, and usually most API Keys are hidden or partially hidden using Asterisks.

My PR addresses this small enhancement.

Fixes #39194
asterisk
ellipses

Submission Review Guidelines:

Changes proposed in this Pull Request:

Replace ellipses with asterisk in the REST API tab in Settings to enhance the look of this page.

Closes #39194 .

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

  1. Visit /wp-admin/admin.php?page=wc-settings&tab=advanced&section=keys
  2. View created keys (or add a new one for testing purposes if currently there are none)
  3. Look at the format of the partially hidden Consumer Key in the second column.

Changelog entry

  • Automatically create a changelog entry from the details below.

Replace the ellipses with asterisks which partially display the active Consumer Keys in the REST API tab.

Significance

  • Patch
  • Minor
  • Major

Type

  • Fix - Fixes an existing bug
  • Add - Adds functionality
  • Update - Update existing functionality
  • Dev - Development related task
  • Tweak - A minor adjustment to the codebase
  • Performance - Address performance issues
  • Enhancement

Message

Replace the ellipses with asterisks which partially display the active Consumer Keys in the REST API tab.

Comment

Replaced Ellipses for asterisk when hiding part of the API Key
@github-actions github-actions bot added plugin: woocommerce Issues related to the WooCommerce Core plugin. type: community contribution labels Jul 12, 2023
@woocommercebot woocommercebot requested review from a team and barryhughes and removed request for a team July 12, 2023 07:23
@github-actions
Copy link
Contributor

Hi ,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

@barryhughes
Copy link
Member

Thanks for submitting this!

Neither ellipses nor asterisks align with the way some popular services such as GitHub or Google Cloud Platform do things (not that we need to align with them) but, anecdotally, I think you're right that asterisks are a more common pattern.

Can you update the PR description, expand the details section and populate the information we need for a changelog?

@SavPhill
Copy link
Contributor Author

Thanks for submitting this!

Neither ellipses nor asterisks align with the way some popular services such as GitHub or Google Cloud Platform do things (not that we need to align with them) but, anecdotally, I think you're right that asterisks are a more common pattern.

Can you update the PR description, expand the details section and populate the information we need for a changelog?

Thank you Barry. I have updated the details and added the changelog.

@barryhughes
Copy link
Member

Significance: patch
Type: tweak

When displaying partial consumer keys in the REST API settings, replace ellipses with asterisks.

Unfortunately, your branch permissions won't let our workflow generate the changelog file. Can you add the above to plugins/woocommerce/changelog/fix-39194? Our automated checks will not let us merge without the changelog.

Copy link
Member

@barryhughes barryhughes left a comment

Choose a reason for hiding this comment

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

Seems reasonable, but we will need the changelog entry to merge (branch permissions mean we can't do this for you).

Branch permissions won't let the workflow generate the changelog file.
@SavPhill
Copy link
Contributor Author

SavPhill commented Jul 14, 2023

Seems reasonable, but we will need the changelog entry to merge (branch permissions mean we can't do this for you).

@barryhughes I have added the changelog, however I notice that the 'Changelog Auto Add' Check is still failing. Could you kindly help to point me in the direction to fix this? Thank you.

@barryhughes
Copy link
Member

Thanks! We are able to ignore that specific check, so long as the other required checks pass. I'm just waiting for what I think is a flaky test to re-run and pass—then I'll go ahead and merge.

@barryhughes barryhughes merged commit 8a3893c into woocommerce:trunk Jul 14, 2023
@github-actions github-actions bot added this to the 8.0.0 milestone Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

plugin: woocommerce Issues related to the WooCommerce Core plugin. type: community contribution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Enhancement]: Replace Ellipsis

2 participants