refactor(readme-generator): use better names (#2261)
This commit is contained in:
parent
e4875c4352
commit
7722d0c86c
25
.github/workflows/app-list-generator.yml
vendored
25
.github/workflows/app-list-generator.yml
vendored
|
@ -1,25 +0,0 @@
|
||||||
name: app-list-generator
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- "master"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
generate-readme-file:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Install Bun
|
|
||||||
uses: oven-sh/setup-bun@v1
|
|
||||||
|
|
||||||
- name: Delete old readme (just in case)
|
|
||||||
run: rm README.md
|
|
||||||
|
|
||||||
- name: Generate new README.md file
|
|
||||||
run: bun app-list-generator.ts
|
|
||||||
|
|
||||||
- name: Create Pull Request
|
|
||||||
uses: peter-evans/create-pull-request@v5
|
|
30
.github/workflows/readme-generator.yml
vendored
Normal file
30
.github/workflows/readme-generator.yml
vendored
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
name: Readme Generator
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow-dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
generate-readme-file:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Install Bun
|
||||||
|
uses: oven-sh/setup-bun@v1
|
||||||
|
|
||||||
|
- name: Generate new README.md file
|
||||||
|
run: bun reamde-generator.ts
|
||||||
|
|
||||||
|
- name: Create Pull Request
|
||||||
|
uses: peter-evans/create-pull-request@v5
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
commit-message: |
|
||||||
|
docs: regenerate readme app list
|
||||||
|
committer: GitHub <noreply@github.com>
|
||||||
|
author: GitHub <noreply@github.com>
|
||||||
|
branch: bot/readme-update
|
||||||
|
title: |
|
||||||
|
readme-generator: update readme
|
||||||
|
labels: bot
|
|
@ -45,15 +45,15 @@ const writeToReadme = async (appsList) => {
|
||||||
let finalReadme = `# Tipi App Store ⛺️
|
let finalReadme = `# Tipi App Store ⛺️
|
||||||
|
|
||||||
This is the official repository for the Tipi App Store. It contains all the apps that are available for download on [Tipi](https://github.com/meienberger/runtipi).
|
This is the official repository for the Tipi App Store. It contains all the apps that are available for download on [Tipi](https://github.com/meienberger/runtipi).
|
||||||
|
|
||||||
## Apps available
|
## Apps available
|
||||||
|
|
||||||
${appsList}
|
${appsList}
|
||||||
|
|
||||||
## How to sumbit an app
|
## How to sumbit an app
|
||||||
|
|
||||||
If you want to see new apps on Tipi you can either:
|
If you want to see new apps on Tipi you can either:
|
||||||
|
|
||||||
- [Open an issue](https://github.com/meienberger/runtipi-appstore/issues) on this repository and members of the community will add it
|
- [Open an issue](https://github.com/meienberger/runtipi-appstore/issues) on this repository and members of the community will add it
|
||||||
- [Join the Discord](https://discord.gg/Bu9qEPnHsc) members of the community will add it.
|
- [Join the Discord](https://discord.gg/Bu9qEPnHsc) members of the community will add it.
|
||||||
- Fork this repo and create the necessary files for a Tipi app. Follow this [guide](<[https://github.com/meienberger/runtipi/wiki/Adding-your-own-app](https://www.runtipi.io/docs/contributing/adding-a-new-app)>)`;
|
- Fork this repo and create the necessary files for a Tipi app. Follow this [guide](<[https://github.com/meienberger/runtipi/wiki/Adding-your-own-app](https://www.runtipi.io/docs/contributing/adding-a-new-app)>)`;
|
Loading…
Reference in New Issue
Block a user