Skip to content
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.

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

Add GH action to update middleware READMEs #1505

Closed
crandmck opened this issue May 2, 2024 · 5 comments
Closed

Add GH action to update middleware READMEs #1505

crandmck opened this issue May 2, 2024 · 5 comments

Comments

@crandmck
Copy link
Member

crandmck commented May 2, 2024

Docs for the middleware modules linked from https://expressjs.com/en/resources/middleware.html are sourced from
the README files in the corresponding repos and are copied to _includes/readmes using get-readmes.sh. So, e.g., https://expressjs.com/en/resources/middleware/body-parser.html comes from https://github.com/expressjs/body-parser/blob/master/README.md.

Similar to #1504 this issue is a task to add a GH action to perform this task. However, since it should run whenever any of the middleware READMEs are updated, it might require an action be added to each of those repos so that it would get triggered when that occurs....unless there's a way to detect a change to a particular file in another repo and perform an action when that happens. Since I am not an expert on GH actions, I will defer to someone who is.

Also some community docs from the expressjs/express repo are similarly reproduced on the website in Resources > Contributing to Express, cf. #1507 and it would be great to automate that, too.

@chrisdel101
Copy link
Contributor

I have no experience with this kind of thing but I am available to give this one a shot. Unless it requires admin GH permissions?

@crandmck
Copy link
Member Author

Awesome!

Re admin rights, I'm not sure tbh. Maybe @jonchurch knows.

@bjohansebas
Copy link
Member

#1559

@bjohansebas
Copy link
Member

bjohansebas commented Aug 26, 2024

@crandmck The workflow could not be executed because the event peter-evans/create-pull-request@v5 is not allowed in the repository. If allowed, we could verify if the workflow works correctly. Alternatively, I can modify the workflow to use gr2m/create-or-update-pull-request-action@1, which is allowed in the repository.

edit: It works correctly bjohansebas#4

@crandmck
Copy link
Member Author

crandmck commented Sep 3, 2024

Fixed by #1559

@crandmck crandmck closed this as completed Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants