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

Verify crate keywords do not exceed 5 #2198

Open
heaths opened this issue Feb 19, 2025 · 3 comments
Open

Verify crate keywords do not exceed 5 #2198

heaths opened this issue Feb 19, 2025 · 3 comments
Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system.

Comments

@heaths
Copy link
Member

heaths commented Feb 19, 2025

We had several crates get rejected from publishing because we had more than 5 keywords. We should check for this so we're not getting caught by this right at the end.

@heaths heaths added Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system. labels Feb 19, 2025
@github-project-automation github-project-automation bot moved this to Untriaged in Azure SDK Rust Feb 19, 2025
@heaths
Copy link
Member Author

heaths commented Feb 20, 2025

We should also validate that we don't duplicate words in the crate name, since the crates.io search relevance is based on:

  1. Crate name
  2. Keywords
  3. Description
  4. README

/cc @ronniegeraghty

@ronniegeraghty
Copy link
Member

ronniegeraghty commented Feb 21, 2025

My suggestions for keywords that don't repeat words in the crate name and descriptions for our existing set of crates. Open to feedback on these.

  • azure_core:

    • keywords:
      • cloud
      • services
      • API
      • REST
      • HTTP
    • description: azure_core provides shared primitives, abstractions, and helpers for modern Rust Azure SDK client libraries. It includes functionalities such as configuring service clients, accessing HTTP response details, and handling errors consistently.
  • azure_core_amqp:

    • keywords:
      • messaging
      • communication
      • non-blocking
      • transport
      • interface
    • description: azure_core_amqp provides core AMQP protocol support for the Azure SDK for Rust, including functionalities for establishing connections, managing sessions, and handling message exchanges over the AMQP protocol.
  • azure_messaging_eventhubs:

    • keywords:
      • streaming
      • data
      • ingestion
      • processing
      • real-time
    • description: azure_messaging_eventhubs provides client libraries for interacting with Azure Event Hubs, allowing developers to build event-driven applications and process large volumes of data.
  • azure_security_keyvault_secrets:

    • keywords:
      • encryption
      • secure
      • credentials
      • access
      • API-key
    • description: azure_security_keyvault_secrets provides client libraries for managing secrets in Azure Key Vault, allowing developers to securely store and retrieve sensitive information such as API keys and passwords.
  • azure_security_keyvault_keys:

    • keywords:
      • encryption
      • secure
      • credentials
      • access
      • protection
    • description: azure_security_keyvault_keys provides client libraries for managing encryption keys in Azure Key Vault, allowing developers to securely store, retrieve, and manage cryptographic keys used for data encryption and decryption.
  • azure_identity:

    • keywords:
      • authorization
      • security
      • token
      • credentials
      • authentication
    • description: azure_identity provides a unified API for authenticating with Azure services using various authentication methods, simplifying the process of acquiring tokens and managing authentication flows.

@heaths
Copy link
Member Author

heaths commented Feb 21, 2025

Who's going to search for creates with "API" or "SDK". They all have them. Also, secrets isn't used for encryption.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system.
Projects
Status: Untriaged
Development

No branches or pull requests

2 participants