DEV Community

Yan.ts
Yan.ts

Posted on

 

Automatizando o Readme do GitHub

Today I Learned 10/05/2022

O GitHub a um tempo atrás lançou uma feature muito interessante que é basicamente readme do seu profile, se você criar um repositório com o mesmo nome que o seu usuário no GitHub e dentro desse repositório criar um README.md, ele aparece assim que o seu perfil é aberto. Print do meu perfil

Isso é muito legal para falar um pouco mais sobre você e o que anda pensando, mas para além disso ele pode ser combinado com o github actions para fazer algumas coisas muito legais.

Para isso basta adicionarmos uma pasta .github e criarmos os nossos arquivos de actions. Hoje a integração que fiz foi a de adicionar os meus posts mais recentes do Dev.to. fiz isso utilizando a action Blog Post Workflow

Para reproduzir basta no readme adicionar a seguinte sessão

# Blog posts
<!-- BLOG-POST-LIST:START -->
<!-- BLOG-POST-LIST:END -->
Enter fullscreen mode Exit fullscreen mode

e na pasta .github criar um arquivo com o nome blog-post-worflow.yml e copiar o seguinte código

name: Latest blog post workflow
on:
  schedule: # Run workflow automatically
    - cron: '0 0 * * *' # Runs every day
  workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the Github Actions Workflow page directly

jobs:
  update-readme-with-blog:
    name: Update this repo's README with latest blog posts
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Pull in dev.to posts
        uses: gautamkrishnar/blog-post-workflow@master
        with:
          feed_list: "https://dev.to/feed/yanpiing"
Enter fullscreen mode Exit fullscreen mode

onde no feed_list você muda para o seu nome de usuário no dev.to ou para qualquer feed de blog que você possua, esse job vai rodar diariamente atualizando os posts

Top comments (0)

50 CLI Tools You Can't Live Without

>> Check out this classic DEV post <<