Adds workflows to insert readme content

This commit is contained in:
Alicia Sykes 2024-02-25 15:28:55 +00:00
parent 24e59790d0
commit 83be8f8dbc
2 changed files with 54 additions and 20 deletions

View file

@ -1,27 +1,11 @@
# Inserts list of contributors and community members into ./docs/credits.md
# Also generates an SVG showing all contributors, which is embedded into readme
name: 📊 Generate Contributor Credits
on:
workflow_dispatch: # Manual dispatch
schedule:
- cron: '0 5 * * 6' # Every Saturday morning.
jobs:
# Job #1 - Generate an embedded SVG asset, showing all contributors
generate-contributors:
runs-on: ubuntu-latest
steps:
- uses: bubkoo/contributors-list@v1
with:
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
svgPath: .github/assets/CONTRIBUTORS.svg
affiliation: all
includeBots: false
excludeUsers: snyk-bot
avatarSize: 96
userNameHeight: 20
svgWidth: 830
commitMessage: 'Updates contributor SVG'
# Job #2 - Inserts sponsors into credits page
# Job #1 - Inserts sponsors into README
insert-sponsors:
runs-on: ubuntu-latest
steps:
@ -31,8 +15,8 @@ jobs:
uses: JamesIves/github-sponsors-readme-action@1.0.5
with:
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
file: '.github/CREDITS.md'
# Job #3 - Inserts contributors into credits page
file: '.github/README.md'
# Job #2 - Inserts contributors into README
insert-credits:
runs-on: ubuntu-latest
name: Inserts contributors into credits.md
@ -43,7 +27,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
with:
image_size: 80
readme_path: .github/CREDITS.md
readme_path: .github/README.md
columns_per_row: 6
commit_message: 'Updates contributors list'
committer_username: liss-bot

View file

@ -0,0 +1,50 @@
name: 📚 Inserts Awesome Privacy into README
on:
workflow_dispatch:
push:
branches: [ main ]
paths: ['awesome-privacy.yml']
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository 🛎️
uses: actions/checkout@v2
# Get current date-time (used for commit message)
- name: Get Date 📅
id: date
run: echo "::set-output name=date::$(date +'%d-%b-%Y')"
# Downloads + installs Python (used for running gen scripts)
- name: Set up Python 🐍
uses: actions/setup-python@v2
with:
python-version: '3.x'
# Install contents of requirements.txt
- name: Install dependencies 📥
run: |
python -m pip install --upgrade pip
cd lib && pip install -r requirements.txt
# The make command triggers all the Python scripts, generates output
- name: Run make command 🔨
run: python lib/awesome-privacy-readme-gen.py
# Commit and push the outputed readme
- name: Commit and push generated files ⤴️
run: |
git config --global user.name "Liss-Bot"
git config --global user.email "alicia-gh-bot@mail.as93.net"
git pull origin main
git add .github/README.md
if git diff --staged --quiet; then
echo "Nothin new added, so nothing to commit, exiting..."
else
git commit -m "Updated Awesome Privacy content (last modified on ${{ steps.date.outputs.date }})"
git push
fi