Skip to content

Commit

Permalink
VUU-1118: WIP Create GH Action to generate README
Browse files Browse the repository at this point in the history
  • Loading branch information
pling-scottlogic committed Jan 11, 2024
1 parent 7623b26 commit c4832b8
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/generate-readme.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh

printf '[//]: # (This file is auto-generated by GitHub Actions. Please do not edit manually.)\n\n' > README_AUTO.md
{ cat $(cat ./docs/readme_contents.txt) ; } >> README_AUTO.md
18 changes: 18 additions & 0 deletions .github/workflows/generate-readme.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Generate README from docs folder
on: push

jobs:
run:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3
- name: Generate readme
run: bash .github/workflows/generate-readme.sh
- name: Commit
uses: EndBug/add-and-commit@v9
with:
message: 'Update readme'
add: 'README_AUTO.md'
default_author: github_actions
2 changes: 2 additions & 0 deletions docs/readme_contents.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
./docs/introduction/*.md
./docs/getting_started/*.md

0 comments on commit c4832b8

Please sign in to comment.