diff --git a/.github/composite-actions/install/action.yml b/.github/composite-actions/install/action.yml index 0372bbd3..39ea9a5d 100644 --- a/.github/composite-actions/install/action.yml +++ b/.github/composite-actions/install/action.yml @@ -19,8 +19,8 @@ runs: - name: ⚙️ Setup Git User shell: bash run: | - git config --global user.email "brunotot10000@gmail.com" - git config --global user.name "Bruno Tot" + git config --global user.email "github-actions[bot]@users.noreply.github.com" + git config --global user.name "github-actions[bot]" - name: Install dependencies shell: bash diff --git a/.github/workflows/readme-generator.yml b/.github/workflows/readme-generator.yml new file mode 100644 index 00000000..4772b1c9 --- /dev/null +++ b/.github/workflows/readme-generator.yml @@ -0,0 +1,26 @@ +name: MERN Sample App - ReadMe + +on: + push: + paths: + - "assets/md/**" + branches: + - main + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: 🛒 Checkout Repository + uses: actions/checkout@v4 + + - name: 🤳 Install + uses: ./.github/composite-actions/install + + - name: 🔥 Generate README.md + run: pnpm run script:writeReadmeMarkdown + + - name: Push code + uses: stefanzweifel/git-auto-commit-action@v5 diff --git a/.github/workflows/typedoc.yml b/.github/workflows/typedoc-generator.yml similarity index 100% rename from .github/workflows/typedoc.yml rename to .github/workflows/typedoc-generator.yml diff --git a/README.md b/README.md index a0b737d2..32d03455 100644 --- a/README.md +++ b/README.md @@ -66,9 +66,9 @@ Our goal is to provide an easy setup and deployment process, allowing developers - [x] Read and write permissions - [x] Allow GitHub Actions to create and approve pull requests -3. Navigate to **Repo > Actions > typedoc.yml** and click on **Run workflow**. +3. Navigate to **Repo > Actions > typedoc-generator.yml** and click on **Run workflow**. -4. After **typedoc.yml** finishes, the `gh-pages` branch is generated. +4. After **typedoc-generator.yml** finishes, the `gh-pages` branch is generated. Navigate to **Repo > Settings > Pages** and save the `gh-pages` branch as the deployment branch. diff --git a/assets/md/4-installation.md b/assets/md/4-installation.md index d5941923..2a87d646 100644 --- a/assets/md/4-installation.md +++ b/assets/md/4-installation.md @@ -9,9 +9,9 @@ - [x] Read and write permissions - [x] Allow GitHub Actions to create and approve pull requests -3. Navigate to **Repo > Actions > typedoc.yml** and click on **Run workflow**. +3. Navigate to **Repo > Actions > typedoc-generator.yml** and click on **Run workflow**. -4. After **typedoc.yml** finishes, the `gh-pages` branch is generated. +4. After **typedoc-generator.yml** finishes, the `gh-pages` branch is generated. Navigate to **Repo > Settings > Pages** and save the `gh-pages` branch as the deployment branch.