backstage icon indicating copy to clipboard operation
backstage copied to clipboard

feat(playlists): implement playlist plugin

Open kuangp opened this issue 2 years ago • 2 comments

Signed-off-by: Phil Kuang [email protected]

Hey, I just made a Pull Request!

(Apologies for the giant change here 😅)

I put together an implementation of my playlist idea from #6063 but generalized for all entities. Check out the READMEs and demo below for more details!

https://user-images.githubusercontent.com/6998196/181414962-d7a03506-bc95-4a7d-8576-3740e6fde6d9.mov

Potential Future Enhancements

  • Clean up of stale entities refs (deleted entities that are still referenced by playlists)
  • UI customization for integrators
  • Playlist search collator / ResultListItem to add playlists to search
  • More metadata to improve discoverability of useful playlists eg. tags?
  • Pagination to support scaling
  • Distributed edits / conflict resolution support (if we want to get fancy 😁)

:heavy_check_mark: Checklist

  • [x] A changeset describing the change and affected packages. (more info)
  • [x] Added or updated documentation
  • [x] Tests for new functionality and regression tests for bug fixes
  • [x] Screenshots attached (for UI changes)
  • [x] All your commits have a Signed-off-by line in the message. (more info)

kuangp avatar Jul 28 '22 03:07 kuangp

Changed Packages

Package Name Package Path Changeset Bump Current Version
example-app packages/app none v0.2.75-next.3
example-backend packages/backend none v0.2.75-next.3
@backstage/core-components packages/core-components patch v0.11.1-next.3
@backstage/plugin-playlist-backend plugins/playlist-backend minor v0.0.0
@backstage/plugin-playlist-common plugins/playlist-common minor v0.0.0
@backstage/plugin-playlist plugins/playlist minor v0.0.0
@backstage/plugin-search-react plugins/search-react patch v1.1.0-next.2

github-actions[bot] avatar Jul 28 '22 04:07 github-actions[bot]

Hey @kuangp sorry I was holding off reviewing this as had a few other bits going on, will get to it this week! :pray:

benjdlambert avatar Aug 08 '22 12:08 benjdlambert

Just a quick pass right now, but I'm wondering about the naming of the plugin. playlist is a bit ambiguous. Not sure 🤷 @backstage/maintainers?

perhaps entity-playlist ?

kuangp avatar Aug 16 '22 19:08 kuangp

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If you are the author and the PR has been closed, feel free to re-open the PR and continue the contribution!

github-actions[bot] avatar Aug 31 '22 14:08 github-actions[bot]

@benjdlambert @Rugvip quick reminder that this is still here awaiting further feedback 😁

kuangp avatar Aug 31 '22 18:08 kuangp

@kuangp yep sorry, on my radar! It's a big one so needs a bigger chunk of time, which I haven't sliced out just yet 😅

Rugvip avatar Aug 31 '22 18:08 Rugvip

@kuangp yep sorry, on my radar! It's a big one so needs a bigger chunk of time, which I haven't sliced out just yet 😅

no worries! just want to make sure this doesn't go stale 😄

kuangp avatar Aug 31 '22 18:08 kuangp

@Rugvip updated based on your feedback! let me know what you think 🙂

kuangp avatar Sep 07 '22 03:09 kuangp

@Rugvip updated !

kuangp avatar Sep 07 '22 20:09 kuangp

cc: @iamEAP @emmaindal and the techdocs folks if you guys can take a look when you get the chance please 🙏 Would love to get this in for the next stable release 😁

kuangp avatar Sep 12 '22 13:09 kuangp

@camilaibs updated based on your suggestion, thanks for taking a look!

kuangp avatar Sep 16 '22 19:09 kuangp

@kuangp this is amazing addition ❤️

Excited for the release 😉

NishkarshRaj avatar Sep 19 '22 15:09 NishkarshRaj