Create an action to check README.md was regenerated on PR #34
Conversation
msadowski
changed the title
| - name: Install dependencies | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install -r .utils/requirements.txt || true |
There was a problem hiding this comment.
Why || true here? Should we let it error here if install fails?
There was a problem hiding this comment.
Agree, let's fail if this fails for any reason
CONTRIBUTING
Outdated
| - `visualize_url` - the url to Foxglove visualization (optional) | ||
|
|
||
| When creating a merge request, a GitHub action should automatically regenerate the README based on your metadata. To test it yourself, you can run the python script `.utils/generate_readme.py` in the root of this repo. | ||
| 4. Regenerate the main README.md by running `python .utils/generate_readme.py` from the root of the repo (install `.utils/requirements.txt` if needed). |
There was a problem hiding this comment.
Might be worth fleshing out the "install requirements" in a separate section, though I know there are multiple ways to do it.
There was a problem hiding this comment.
I added a new section with the pip command I use for installing requirements
|
|
||
| on: | ||
| pull_request: | ||
| paths: |
There was a problem hiding this comment.
I think this is limiting the action to only run when these files have changed, right? But we want to check that the readme is up-to-date whenever content is added, so we should probably remove these.
There was a problem hiding this comment.
I removed this and made it run on all pull requests
This PR adds a GitHub action that checks that the main README.md file is up to date. If someone forgets to autogenerate the files or modifies the file by hand, the action will fail.