Skip to content

Add recurring documentation issue #1956

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.

Sign up for GitHub

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

Merged
Weltraumschaf merged 2 commits into from
Sep 14, 2023
Merged

Add recurring documentation issue #1956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3381723
Add action which creates a documentation issue on the 15th of each month
Sep 14, 2023
30c4021
Rename GitHub token
Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_roulette.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "📚 Recurring documentation issue"
labels: documentation
---
Congratulations @{{ env.MEMBER }}, you were randomly selected to review our documentation for 2h. Have fun 😉
45 changes: 45 additions & 0 deletions .github/workflows/documentation-roulette.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# SPDX-FileCopyrightText: the secureCodeBox authors
#
# SPDX-License-Identifier: Apache-2.0

# Some parts copied and modified from https://github.com/garnertb/get-team-members/ Copyright (c) 2022 Tyler Garner

name: Documentation Roulette
on:
schedule:
- cron: "0 12 15 * *" # At 12:00 UTC on day-of-month 15

jobs:
docu-roulette:
permissions:
issues: write # needed to create new issues
runs-on: ubuntu-22.04
if: github.repository == 'secureCodeBox/secureCodeBox'
steps:
- name: Checkout repository
uses: actions/checkout@v3

# Request team members with the GitHub API using their gh cli
- name: Fetch core-team members
id: fetch-members
run: |
echo MEMBERS=$(gh api --paginate -X GET /orgs/$ORG/teams/$TEAM_SLUG/members | jq 'reduce inputs as $i (.; . += $i)') >> $GITHUB_OUTPUT
env:
ORG: secureCodeBox
TEAM_SLUG: core-team
GH_TOKEN: ${{ secrets.SCB_BOT_DOCU_ROULETTE_TOKEN }} # Token used here needs org:read permission

# Select random member from team response
- name: Select the chosen member
run: |
MEMBERS=(${{ join(fromJson(steps.fetch-members.outputs.MEMBERS).*.login, ' ') }})
size=${#MEMBERS[@]}
index=$(($RANDOM % $size))
echo "MEMBER=${MEMBERS[$index]}" >> $GITHUB_ENV

# Create issue and insert chosen member ({{ env.MEMBER}} in template)
- uses: JasonEtco/create-an-issue@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
filename: .github/ISSUE_TEMPLATE/documentation_roulette.md