Cartões do YouTube no Readme do GitHub (GitHub Readme YouTube Cards)

Workflow para exibir vídeos recentes do YouTube em cartões SVG no seu arquivo README.

Uso

1. É nescessário inserir o código abaixo no README para que o cartão seja visulizado.

<!-- BEGIN YOUTUBE-CARDS -->
<!-- END YOUTUBE-CARDS -->

2. No seu repositório, crie uma pasta .github e dentro dela uma outra pasta de nome workflows caso você já não tenha uma então, crie um arquivo dentro da pasta .github/workflows/ e der a ele o nome de youtube-cards.yml e adicione o código abaixo.

name: GitHub Readme YouTube Cards
on:
  schedule:
    # Executa toda hora, na hora certa
    - cron: "0 * * * *"
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    # Permite que o trabalho seja confirmado no repositório
    permissions:
      contents: write
    # Executa os Cartões do YouTube no seu Readme do GitHub
    steps:
      - uses: DenverCoder1/github-readme-youtube-cards@main
        with:
          # ID do seu canal no YouTube
          channel_id: UCipSxT7a3rn81vGLw9lqRkg

Parâmetros

DenverCoder1/github-readme-youtube-cards@main

Clique para exibir/fechar os parâmetros

Nome	Tipo	Obrigatório	Padrão	Descrição	Mais Observações
channel_id	string	true		ID do seu canal no YouTube
playlist_id	string			ID da Playlist
lang	string		en	Idioma
comment_tag_name	string		YOUTUBE-CARDS	O texto na tag de comentário para substituir o conteúdo
youtube_api_key	string			Chave da API do YouTube
max_videos	number		6	Máximo de vídos que devem ser exibidos
base_url	string		https://ytcards.demolab.com/	A URL base a ser usada para nos cartões
card_width	number		250	A largura dos cartões SVG	Unidade: pixels.
border_radius	number		5	O raio da borda dos cartões SVG
background_color	string		#0d1117	Cor de fundo dos nos cartões SVG
title_color	string		#ffffff	A cor do texto do título
stats_color	string		#dedede	A cor do texto das estatísticas
theme_context_light	any		{}	Objeto JSON em cores do modo claro
theme_context_dark	any		{}	Objeto JSON em cores do modo escuro
max_title_lines	number		1	O máximo de linhas a serem usadas no título
show_duration	boolean		false	Exibir ou ocultar o tempo de duração dos vídeos	Nescessita da seu chave da API do YouTube, youtube_api_key.
author_name	string		GitHub Actions	O nome do autor do commit
author_email	string		41898282+github-actions[bot]@users.noreply.github.com	O email do autor do commit
commit_message	string		docs(readme): Update YouTube cards	A mensagem de commit para o commit
readme_path	string		README.md	O caminho do arquivo Markdown ou HTML que será atualizado
output_only	boolean		false	Pular ou não a gravação do arquivo readme
output_type	string		markdown	Saída da sintaxe a ser usada	Opções disponíveis: markdown e html.
markdown	string	true		O Markdown ou HTML gerado que é usado para atualizar o arquivo README
committed	string	true		Caso a ação tenha criado um commit	Possibilidades: true e false.
commit_long_sha	string	true		O SHA completo do commit que acabou de ser criado
commit_sha	string	true		O uso de uma SHA curta com 7 caracteres do commit que acabou de ser criado
pushed	string	true		Caso a atualização foi efetuado no no repositório remoto	Possibilidades: true e false.

Exemplos

# Example usage: https://github.com/DenverCoder1/github-readme-youtube-cards/blob/main/.github/workflows/youtube-cards.yml
name: GitHub Readme YouTube Cards
on:
  schedule:
    # Runs every day at 12:00
    - cron: "0 12 * * *"
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: DenverCoder1/github-readme-youtube-cards@main
        id: youtube-cards
        with:
          channel_id: UCipSxT7a3rn81vGLw9lqRkg
          youtube_api_key: ${{ secrets.YOUTUBE_API_KEY }}
          show_duration: true
          theme_context_light: '{ "background_color": "#ffffff", "title_color": "#24292f", "stats_color": "#57606a" }'
          theme_context_dark: '{ "background_color": "#0d1117", "title_color": "#ffffff", "stats_color": "#dedede" }'
          max_title_lines: 2
          output_type: html
      - run: echo OUTPUT '${{ steps.youtube-cards.outputs.markdown }}'
        shell: bash