Skip to content

Conversation

@omajid
Copy link
Member

@omajid omajid commented Apr 30, 2025

This repo contains man pages. They are generated from another repo, and need to be updated manually. Generally, someone updates them once a year or so, and often it's too late for GA:

So automate the update using GitHub Actions.

done

# rm -rf docs-main
rm -rf docs-main
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a sub-repo (or a subdirectory) that we never want to git add.

run: |
set -euo pipefail
rm ./documentation/manpages/sdk/*
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleting everything allows stale pages to be removed.

@omajid
Copy link
Member Author

omajid commented Apr 30, 2025

@omajid
Copy link
Member Author

omajid commented May 1, 2025

cc @am11 @baronfel @marcpopMSFT

Copy link
Member

@baronfel baronfel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple comments. Making a workflow out of this makes perfect sense to me, I just have a few questions I'm asking internally about permissions/security.

@baronfel
Copy link
Member

baronfel commented May 9, 2025

I chatted with some folks internally and they've ok'd it. Let's get the email/username thing updated and get this in!

@edvilme
Copy link
Contributor

edvilme commented May 10, 2025

I am curious. Does this target changes to main only? Or does it also track release/xx branches? I personally wouldn't expect much user-facing changes that would be relevant for manpages in between versions, but should this be something we need to consider?

@omajid
Copy link
Member Author

omajid commented May 12, 2025

I am curious. Does this target changes to main only?

The docs say that scheduled workflows only run on main, and wouldn't run on other branches.

omajid added 2 commits May 12, 2025 06:29
This repo contains man pages. They are generated from another repo, and
need to be updated manually. Generally, someone updates them once a year
or so, and often it's too late for GA:

- dotnet#36447
- dotnet#29032

So automate the update using GitHub Actions.
- Use better name/email for git commit

- More details in the PR
@omajid omajid force-pushed the workflow-update-man-pages branch from 22260ed to f54b3b2 Compare May 12, 2025 10:40
@omajid
Copy link
Member Author

omajid commented May 12, 2025

Thanks, @baronfel ! PR is good to go from my side.

@edvilme
Copy link
Contributor

edvilme commented May 12, 2025

I am curious. Does this target changes to main only?

The docs say that scheduled workflows only run on main, and wouldn't run on other branches.

Oh great thanks, wasn't sure about that :)

@marcpopMSFT marcpopMSFT merged commit fd301ec into dotnet:main May 23, 2025
30 checks passed
@marcpopMSFT
Copy link
Member

Thanks for the contribution. Good idea to automate this more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants