docs: 🎨 updated readme

docs: 🎨 updated readme
This commit is contained in:
Leifer Mendez
2022-12-29 14:53:19 +01:00
committed by GitHub
5 changed files with 66 additions and 47 deletions

46
.github/workflows/netlify-dev.yml vendored Normal file
View File

@@ -0,0 +1,46 @@
name: 📄 Desplegando documentacion
on:
pull_request:
branches:
- 'feat/docs-**'
- 'fix/docs-**'
push:
branches:
- 'feat/docs-**'
- 'fix/docs-**'
jobs:
############ DOCUMENTATION BUILD ############
build-documentation:
name: Build Package
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 16.x
cache: 'yarn'
registry-url: https://registry.npmjs.org/
- run: corepack enable
- name: Install NPM Dependencies
run: yarn install --immutable --network-timeout 300000
- name: Add netlify
run: yarn add netlify-cli -D
- name: Create .env build file
run: |
touch packages/docs/.env
echo VITE_GITHUB_TOKEN=${{ secrets.COLLABORATORS_TOKEN }} >> packages/docs/.env
- name: Build and Deploy
run: |
cd packages/docs
netlify deploy --build --site ${{ secrets.NETLIFY_SITE_ID }} --auth ${{ secrets.NETLIFY_AUTH_TOKEN }}

View File

@@ -1,10 +1,9 @@
name: 📄 Desplegando documentacion
name: 📄 (PROD) Desplegando documentacion
on:
pull_request:
push:
branches:
- 'feat/docs-**'
- 'fix/docs-**'
- next-release
jobs:
############ DOCUMENTATION BUILD ############
@@ -28,41 +27,15 @@ jobs:
- name: Install NPM Dependencies
run: yarn install --immutable --network-timeout 300000
- name: Build Documentation
run: cd packages/docs && yarn run build
- name: Add netlify
run: yarn add netlify-cli -D
- name: Temporarily save Dist
uses: actions/upload-artifact@v3
with:
name: documentation-dist
path: |
packages/docs/dist/
packages/docs/netlify.toml
packages/docs/.netlify
############ DEPLOY ############
deploy:
runs-on: ubuntu-18.04
needs:
- build-documentation
steps:
- uses: actions/checkout@v2
- name: Create .env build file
run: |
touch packages/docs/.env
echo VITE_GITHUB_TOKEN=${{ secrets.COLLABORATORS_TOKEN }} >> packages/docs/.env
- uses: actions/download-artifact@v3
with:
name: documentation-dist
path: |
packages/docs/dist/
packages/docs/netlify.toml
packages/docs/.netlify
- name: Deploy to Netlify
uses: nwtgck/actions-netlify@v1.2
with:
publish-dir: 'packages/docs/dist'
github-token: ${{ secrets.GITHUB_TOKEN }}
deploy-message: 'Deploy from GitHub Actions'
netlify-config-path: 'packages/docs/netlify.toml'
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
timeout-minutes: 1
- name: Build and Deploy
run: |
cd packages/docs
netlify deploy --prod --build --site ${{ secrets.NETLIFY_SITE_ID }} --auth ${{ secrets.NETLIFY_AUTH_TOKEN }}

View File

@@ -1,10 +1,10 @@
[![Test / Coverage](https://github.com/leifermendez/bot-whatsapp/actions/workflows/ci.yml/badge.svg)](https://github.com/leifermendez/bot-whatsapp/actions/workflows/ci.yml)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
--------
🐤 Tablero de tareas : [https://github.com/users/leifermendez/projects/4/views/1](https://github.com/users/leifermendez/projects/4/views/1)
## Documentacion
[https://bot-whatsapp.netlify.app/](https://bot-whatsapp.netlify.app/)
🦊 Documentación: [https://bot-whatsapp-codigoencasa.pages.dev/](https://bot-whatsapp-codigoencasa.pages.dev/)
Video como hacer PR: https://youtu.be/Lxt8Acob6aU
🐤 Tablero de tareas : [https://github.com/users/leifermendez/projects/4/views/1](https://github.com/users/leifermendez/projects/4/views/1)
🚀 __Roadmap:__ [https://github.com/users/leifermendez/projects/4/views/1](https://github.com/users/leifermendez/projects/4/views/1)

View File

@@ -14,10 +14,10 @@ export default component$(
<a href={props.user.html_url} target="_blank">
<img
class="w-16 h-16 rounded-full mx-auto object-cover"
src={props.user.avatar_url}
src={props.user.avatar_url + '&s=80'}
alt={props.user.login}
width="384"
height="512"
width="80"
height="80"
/>
</a>

View File

@@ -10,9 +10,9 @@ import { RequestHandlerNetlify } from '@builder.io/qwik-city/middleware/netlify-
import { GITHUB_TOKEN } from './docs/constant'
export const onGet: RequestHandlerNetlify = async ({ platform }) => {
console.log(`[🚩 platform]: `, platform)
const CHECK_GITHUB_TOKEN =
(platform as any)?.['GITHUB_TOKEN'] ?? GITHUB_TOKEN
console.log(`[🚩 platform]: `, GITHUB_TOKEN)
const data = await fetchGithub(CHECK_GITHUB_TOKEN)
return data
}