Readme Pull Requests

ReadmePullRequests is designed to automate the process of updating the README.md file in a GitHub repository whenever a pull request (PR) is created.

In addition to automating the update of the README.md file, the workflow also offers advanced customization options:

• Bold Selected Repositories: You can choose to highlight specific repositories by making them bold in the README.md file. This allows you to emphasize certain repositories among the list that the workflow generates.

• Hide Specific Repositories: The workflow provides an option to exclude certain repositories from appearing in the README.md file. This is useful if you want to keep the focus on only the most relevant repositories.

• Direct Links to Pull Requests: You have the option to include direct links to specific pull requests within the README.md. This feature allows users to quickly access the pull requests associated with the changes, providing more context or facilitating easier navigation.

These features make the workflow highly flexible, allowing you to tailor the content of your README.md file to suit your project's needs while maintaining up-to-date documentation.

Instructions

1. Add the comment <!-- PULL_REQUESTS --> (entry point) within README.md.

2. Now you have to create a workflow file.

.github/workflows/ReadmePullRequests.yml

name: Update ReadmePullRequests

on:
  schedule:
    - cron: '*/30 * * * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: Update this repo's README with recent activity

    steps:
      - uses: actions/checkout@v2
      - uses: jcabak/ReadmePullRequests@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

3. Create a GitHub token. You have to create a personal access token. You can find more information here.

4. Go to your repository > Settings > Secrets and variables > Actions > New repository secret Secret part of repository for using it and call it as GH_TOKEN and paste your token in the value part.

The above job runs every half an hour, you can change it as you wish based on the cron syntax.

Override defaults

Use the following input params to customize it for your use case:-

Input Param	Default Value	Description
boldFavorites	true	bold favorite repositories
includePullRequestLinks	false	make url to specific pull request
favoriteRepositories	null	table for favorites users
ignoredRepositories	null	table for ignored users

name: Update ReadmePullRequests

on:
  schedule:
    - cron: '*/30 * * * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: Update this repo's README with recent activity

    steps:
      - uses: actions/checkout@v2
      - uses: jcabak/ReadmePullRequests@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          boldFavorites: true
          includePullRequestLinks: false
          favoriteRepositories : ['rails', 'microsoft', 'apple', 'home-assistant', 'google', 'raspberry', 'twitter', 'mozilla', 'facebook', 'googlechrome', 'nasa', 'w3c', 'basecamp']
          ignoredRepositories: ['BinaryWorlds', 'LukasJoswiak'];

Closed Pull Requests

Icon	User	Repository	Stars	Forks	Pull Request
	basecamp	kamal-site	57	79	Added subtitles for video
	basecamp	kamal-site	57	79	Accessibility and Performance improvements
	w3c	w3c.github.io	144	39	Performance improvement
	Orange-OpenSource	Orange-Confort-plus	42	25	fix typos
	inclusive-design	wecount.inclusivedesign.ca	8	20	fix: sufficient contrast (resolves #1739)
	simple-login	website	43	33	Added variables. Texts were permanently assigned.
	rails	website	75	109	Accessibility and Performance improvements
	EbookFoundation	free-programming-books	339285	61771	fix typo
	microsoft	TypeScript-Website	2242	1375	Performance improvement
	joomla	accessibility	8	12	fix typos
	irdpl	irdpl.github.io	0	1	Accessibility improvements
	irdpl	wcag	7	2	poprawki literówek
	pa11y	pa11y.github.io	8	14	Add Creative Commons image dimensions to markup to improve CLS
	simple-login	website	43	33	SEO, Performance and Accessibility improvements
	simple-login	website	43	33	Multilingual
	gohugoio	hugoDocs	1059	1494	Update editors.md
	homebridge	homebridge.io	9	5	Accessibility and SEO improvements
	swiftlang	swift-org-website	477	187	SEO improvement
	alextselegidis	easyappointments	3366	1275	Update Polish language
	github	government.github.com	1738	981	Performance and SEO improvements
	home-assistant	home-assistant.io	5013	7306	Accessibility and SEO improvements
	google	certificate-transparency-community-site	106	63	Performance improvement
	github	training-kit	4359	4359	Accessibility and SEO improvements
	niw	HapticKey	1648	62	Polish localization
	raspberrypi	documentation	5255	2011	Accessibility and SEO improvements
	twitter	opensource-website	3034	814	Performance, Accessibility and SEO improvements
	instantpage	instant.page-site	14	2	Core Web Vitals Optimization
	mozilla	webext-compat-tool	13	19	Accessibility and SEO improvements
	mozilla	extension-workshop	101	132	Text remains visible during webfont load
	mozilla	webext-compat-tool	13	19	Accessibility and SEO improvements
	microsoft	TypeScript-Website	2242	1375	Links to cross-origin destinations are safe
	google	docsy	2625	905	Accessibility and SEO improvements
	facebook	metro	5238	626	Accessibility improvement
	facebook	react-native-website	1962	4391	Accessibility improvement
	gethugothemes	dot-hugo	263	149	Accessibility and SEO improvements
	nanxiaobei	hugo-paper	2124	490	Added i18n translation - Polish
	gohugoio	hugoDocs	1059	1494	Accessibility and SEO improvements
	GoogleChromeLabs	quicklink	11036	405	Accessibility and SEO improvements
	GoogleChromeLabs	quicklink	11036	405	Accessibility and SEO improvements
	hugo-toha	toha	1048	605	Accessibility and SEO improvements
	gethugothemes	bigspring-light-hugo	204	305	Accessibility and SEO improvements
	wangchucheng	hugo-eureka	926	193	Accessibility and SEO improvements
	wangchucheng	hugo-eureka	926	193	add polish i18n support
	wangchucheng	hugo-eureka	926	193	Accessibility improvements
	microsoft	vscode-loc	566	299	fix typo
	michalczukm	michalczukm.xyz	0	1	Accessibility improvements
	ojroques	hugo-researcher	234	130	Accessibility and SEO improvements
	escalate	hugo-split-theme	76	88	Accessibility and SEO improvements
	GoogleChrome	workbox	12385	820	Update README.md
	google	certificate-transparency-community-site	106	63	Accessibility and SEO improvements
	sindresorhus	caprine	7047	558	Fix "Hide Names and Avatars"
	microsoft	TypeScript-Website-Localizations	118	132	fix typo
	nasa	instructions	338	57	Improved accessibility, performance and SEO
	GoogleChrome	developer.chrome.com	1664	1582	Accessibility improved
	responsively-org	website	22	47	Reduces images file sizes
	responsively-org	website	22	47	Accessibility improved
	responsively-org	responsively-app	22794	1201	Add tooltip to icons on left panel

Open Pull Requests

Icon	User	Repository	Stars	Forks	Pull Request
	w3c	wai-website	60	311	fix typos for Polish language
	simple-login	website	43	33	Added Polish translation
	govtech-polska	fact_checking_portal	1	2	Accessibility improvements
	letsencrypt	website	851	576	Accessibility and SEO improvements
	iina	iina-website	124	29	Accessibility and SEO improvements