Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VUU-1118: Auto-generate README from docs #1119

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

pling-scottlogic
Copy link
Contributor

@pling-scottlogic pling-scottlogic commented Jan 11, 2024

Description

Adds a new GitHub action to automatically update the project's README file whenever changes are made to the relevant files in the docs folder. This relevant files are specified in a text file, which supports the use of wildcards.

Change List

  • Add bash script to generate README from docs folder
  • Add text file to configure which files are included in the resultant README
  • Add new GitHub Action run script and commit result

To Do

  • Decide what information is to be included in README
  • Reorganise docs folder to allow appropriate concatenation
  • Update readme_contents.txt to specify relevant docs files/sub-folders
  • Replace any reference to README_AUTO.md with README.md
  • Drop automatic commit that generated README_AUTO.md

Copy link

netlify bot commented Jan 11, 2024

Deploy Preview for papaya-valkyrie-395400 canceled.

Name Link
🔨 Latest commit 9bc06cd
🔍 Latest deploy log https://app.netlify.com/sites/papaya-valkyrie-395400/deploys/659fcce07467c60008882ee4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant