backstage / backstage/community-plugins

๐Ÿ”Œ Plugin: Cloudsmith

Open
#10,542 3 comments 2 reactions 0 assignees View on GitHub
plugin
Dominant language
TypeScript
Stars
422
Forks
697
Avg merge
2d 6h
Merged PRs (30d)
286

Description

### ๐Ÿ”– Summary

At DPG Media, we have created a plugin for Cloudsmith that adds a tab to entities, listing packages associated with the entity.

Image

### ๐ŸŒ Project website (if applicable)

https://cloudsmith.com

### โœŒ๏ธ Context

The tab appears on entities containing the `cloudsmith.com/packages` annotation, which is a comma-separated list of `/` slugs:

```yaml
metadata:
annotations:
cloudsmith.com/packages: dpg-npm/my-lib, dpg-docker/my-service
```

In the `app-config.yaml` file, the organisation and API key get defined:

```yaml
cloudsmith:
org: dpg-media
apiKey: ${CLOUDSMITH_PLUGIN_API_KEY}
```

The plugin exclusively supports the New Frontend System and is 100% Backstage UI.

### ๐Ÿ‘€ Have you spent some time to check if this plugin request has been raised before?

- [x] I checked and didn't find similar issue

### โœ๏ธ Are you willing to maintain the plugin?

- [x] I understand the responsibilities as a [Plugin Maintainer Governance](https://github.com/backstage/community/blob/main/GOVERNANCE.md#plugin-maintainer) & will maintain the plugin

### ๐Ÿข Have you read the Code of Conduct?

- [x] I have read the [Code of Conduct](https://github.com/backstage/community-plugins/blob/main/CODE_OF_CONDUCT.md)

### Are you willing to submit PR?

Yes I am willing to submit a PR!

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the plugin requirements in this issue, the Cloudsmith project website, and the app-config.yaml example. Verify that entities annotated with cloudsmith.com/packages can display their associated packages and that the documented organisation and API key configuration works with the New Frontend System.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.