Several updates to automation workflow
- Update `generate-readme.yml` to use Python scripts. Previously it was awk scripts. - Rename python script to `generate_readme`. Previously it was called `main.py`. - Add note to `CONTRIBUTING.md` explaining the new file to add manual entries. - Fix typo in `CONTRIBUTING.md`.
This commit is contained in:
parent
d8c755ad1c
commit
abb0285f91
|
|
@ -16,14 +16,9 @@ jobs:
|
|||
- name: Checkout repository
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y gawk
|
||||
|
||||
- name: Generate README.md
|
||||
run: |
|
||||
awk -f scripts/awk/addGithubShields.awk _README.md | awk -f scripts/awk/makeShieldsSquare.awk > README.md
|
||||
python3 generate_readme.py _README.md > README.md
|
||||
|
||||
|
||||
- name: Commit changes
|
||||
|
|
|
|||
|
|
@ -4,11 +4,11 @@ Please note that this project is released with a [Contributor Code of Conduct](c
|
|||
|
||||
Ensure your pull request adheres to the following guidelines:
|
||||
|
||||
- Edit and modify the `README.md` file.
|
||||
- Edit and modify the `_README.md` file. `README.md` is automatically generated from this file.
|
||||
- Ensure that the project you submit does not duplicate existing entries.
|
||||
- Ensuring that the items you submit have at least working documentation for the description.
|
||||
- Ensure that you add new item in alphabetical order
|
||||
- Ensure that the new item have correct category. suggest new one if you find suitable
|
||||
- Ensure that the new item have correct category. Suggest new one if you find suitable
|
||||
- Submit a separate PR for each item.
|
||||
- Format the PR title as `Add item: item name`/`Fix item: item name`.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue