🎼 Music plugin
The music plugin lets you display :
Random tracks from a playlist
Recently listened
|
It can work in the following modes:
Playlist mode
Select randomly a few tracks from a given playlist to share your favorites tracks with your visitors.
Select a music provider below for instructions.
Apple Music
Extract the embed URL of the playlist you want to share.
To do so, connect to music.apple.com and select the playlist you want to share.
From ... menu, select Share and Copy embed code.
Extract the source link from the code pasted in your clipboard:
<iframe allow="" frameborder="" height="" style="" sandbox="" src="https://embed.music.apple.com/**/playlist/********"></iframe>
And use this value in plugin_music_playlist option.
Spotify
Extract the embed URL of the playlist you want to share.
To do so, Open Spotify and select the playlist you want to share.
From ... menu, select Share and Copy embed code.
Extract the source link from the code pasted in your clipboard:
<iframe src="https://open.spotify.com/embed/playlist/********" width="" height="" frameborder="0" allowtransparency="" allow=""></iframe>
And use this value in plugin_music_playlist option.
Last.fm
This mode is not supported for now.
YouTube Music
Extract the playlist URL of the playlist you want to share.
To do so, Open YouTube Music and select the playlist you want to share.
Extract the source link from copying it from the address bar:
https://music.youtube.com/playlist?list=********
And use this value in plugin_music_playlist option.
ℹ️ Examples workflows
➡️ Available options for this plugin
- uses: lowlighter/metrics@latest
with:
# ... other options
plugin_music: yes
plugin_music_limit: 4 # Limit to 4 entries
plugin_music_playlist: https://******** # Use extracted playlist link
# plugin_music_provider: (will be guessed through plugin_music_playlist)
# plugin_music_mode: (will be set to "playlist" when plugin_music_playlist is provided)
Recently played & top modes
- Recently played: Display tracks you have played recently.
- Top: Display your top artists/tracks for a certain time period.
Select a music provider below for additional instructions.
Apple Music
This mode is not supported for now.
I tried to find a way with smart playlists, shortcuts and other stuff but could not figure a workaround to do it without paying the $99 fee for the developer program.
So unfortunately this isn't available for now.
Spotify
Spotify does not have personal tokens, so it makes the process a bit longer because you're required to follow the authorization workflow... Follow the instructions below for a TL;DR to obtain a refresh_token.
Sign in to the developer dashboard and create a new app.
Keep your client_id and client_secret and let this tab open for now.
Open the settings and add a new Redirect url. Normally it is used to setup callbacks for apps, but just put https://localhost instead (it is mandatory as per the authorization guide, even if not used).
Forge the authorization url with your client_id and the encoded redirect_uri you whitelisted, and access it from your browser:
https://accounts.spotify.com/authorize?client_id=********&response_type=code&scope=user-read-recently-played%20user-top-read&redirect_uri=https%3A%2F%2Flocalhost
When prompted, authorize your application.
Once redirected to redirect_uri, extract the generated authorization code from your url bar.
Go back to your developer dashboard tab, and open the web console of your browser to paste the following JavaScript code, with your own client_id, client_secret, authorization code and redirect_uri.
(async () => {
console.log(await (await fetch("https://accounts.spotify.com/api/token", {
method:"POST",
headers:{"Content-Type":"application/x-www-form-urlencoded"},
body:new URLSearchParams({
grant_type:"authorization_code",
redirect_uri:"https://localhost",
client_id:"********",
client_secret:"********",
code:"********",
})
})).json())
})()
It should return a JSON response with the following content:
{
"access_token":"********",
"expires_in": 3600,
"scope":"user-read-recently-played user-top-read",
"token_type":"Bearer",
"refresh_token":"********"
}
Register your client_id, client_secret and refresh_token in secrets to finish setup.
Last.fm
Obtain a Last.fm API key.
To do so, you can simply create an API account or use an existing one.
Register your API key to finish setup.
YouTube Music
Extract your YouTube Music cookies.
To do so, open YouTube Music (whilst logged in) on any modern browser
Open the developer tools (Ctrl-Shift-I) and select the “Network” tab
Find an authenticated POST request. The simplest way is to filter by /browse using the search bar of the developer tools. If you don’t see the request, try scrolling down a bit or clicking on the library button in the top bar.
Click on the Name of any matching request. In the “Headers” tab, scroll to the “Cookie” and copy this by right-clicking on it and selecting “Copy value”.
➡️ Available options
| Option | Type (format) [default] {allowed values} | Description |
|---|---|---|
plugin_music |
boolean [no] |
Display your music tracks |
plugin_music_provider |
string [] {"apple", "spotify", "lastfm", "youtube"} |
Music provider |
plugin_music_token 🔐 |
token [] |
Music provider personal token |
plugin_music_mode |
string [] {"playlist", "recent", "top"} |
Plugin mode |
plugin_music_playlist |
string [] |
Embed playlist url |
plugin_music_limit |
number [4] {1 ≤ 𝑥 ≤ 100} |
Maximum number of tracks to display |
plugin_music_played_at |
boolean [no] |
Display when the track was played |
plugin_music_time_range |
string [short] {"short", "medium", "long"} |
Time period for top mode |
plugin_music_top_type |
string [tracks] {"tracks", "artists"} |
Whether to show tracks or artists in top mode |
plugin_music_user |
string [→ User login] |
Music provider username |
Legend for option icons:
- 🔐 Value should be stored in repository secrets
ℹ️ Examples workflows
name: Apple Music - Random track from playlist
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.music.playlist.svg
token: NOT_NEEDED
plugin_music: 'yes'
plugin_music_playlist: https://embed.music.apple.com/fr/playlist/usr-share/pl.u-V9D7m8Etjmjd0D
plugin_music_limit: 2
name: Spotify - Random track from playlist
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.music.playlist.spotify.svg
token: NOT_NEEDED
plugin_music: 'yes'
plugin_music_playlist: https://open.spotify.com/embed/playlist/3nfA87oeJw4LFVcUDjRcqi
name: Spotify - Recently listed
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.music.recent.svg
token: NOT_NEEDED
plugin_music: 'yes'
plugin_music_provider: spotify
plugin_music_mode: recent
plugin_music_token: ${{ secrets.SPOTIFY_TOKENS }}
plugin_music_limit: 2
name: Spotify - Top tracks
uses: lowlighter/metrics@latest
with:
token: NOT_NEEDED
plugin_music: 'yes'
plugin_music_mode: top
plugin_music_provider: spotify
plugin_music_token: ${{ secrets.SPOTIFY_TOKENS }}
plugin_music_time_range: short
plugin_music_top_type: tracks
name: Spotify - Top artists
uses: lowlighter/metrics@latest
with:
token: NOT_NEEDED
plugin_music: 'yes'
plugin_music_mode: top
plugin_music_provider: spotify
plugin_music_token: ${{ secrets.SPOTIFY_TOKENS }}
plugin_music_time_range: long
plugin_music_top_type: artists
name: Youtube Music - Random track from playlist
uses: lowlighter/metrics@latest
with:
token: NOT_NEEDED
plugin_music: 'yes'
plugin_music_playlist: >-
https://music.youtube.com/playlist?list=OLAK5uy_kU_uxp9TUOl9zVdw77xith8o9AknVwz9U
name: Youtube Music - Recently listed
uses: lowlighter/metrics@latest
with:
token: NOT_NEEDED
plugin_music_token: ${{ secrets.YOUTUBE_MUSIC_TOKENS }}
plugin_music: 'yes'
plugin_music_mode: recent
plugin_music_provider: youtube
name: Last.fm - Recently listed
uses: lowlighter/metrics@latest
with:
token: NOT_NEEDED
plugin_music_token: ${{ secrets.LASTFM_TOKEN }}
plugin_music: 'yes'
plugin_music_provider: lastfm
plugin_music_user: RJ