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 workflow to automate manpage updates #10650

Merged
merged 1 commit into from Feb 20, 2021
Merged

Add workflow to automate manpage updates #10650

merged 1 commit into from Feb 20, 2021

Conversation

nandahkrishna
Copy link
Member

@nandahkrishna nandahkrishna commented Feb 18, 2021

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?
  • Have you successfully run brew man locally and committed any changes?

This PR aims to add a workflow to automate manpage (and completions) updates. Contributors usually run brew man and commit any changes themselves, but automating this step is desirable. I have minimal experience with workflows, but I've based this almost entirely on sorbet.yml.

Currently, I've set the workflow to run on pushes except for specific paths (that would be changed by running brew man), but this could be changed if something else is more apt.

@BrewTestBot
Copy link
Member

Review period will end on 2021-02-19 at 07:13:24 UTC.

@BrewTestBot BrewTestBot added the waiting for feedback Merging is blocked until sufficient time has passed for review label Feb 18, 2021
@nandahkrishna
Copy link
Member Author

I've updated the workflow to run on:

  • schedule (cron)
  • workflow_dispatch (manually)
  • push to branches (in this repository) except master that modify the workflow file
  • pull_request that modify files which could lead to manpage updates.

I'm sure this PR needs to be reviewed/modified a little more, so I've not combined all the scheduled jobs into one scheduled.yml just yet.

@BrewTestBot BrewTestBot removed the waiting for feedback Merging is blocked until sufficient time has passed for review label Feb 19, 2021
@BrewTestBot
Copy link
Member

Review period ended.

@nandahkrishna
Copy link
Member Author

The workflow has been updated to run on:

  • schedule: once a day
  • pushes to master that affect specific paths, which could result in manpage updates.

Copy link
Member

@Rylan12 Rylan12 left a comment

Choose a reason for hiding this comment

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

Thanks for the clarification, Nanda and Mike! I agree, I think the current setup makes sense.

This looks good to me. I haven't tested it out, of course, but I'd be comfortable merging to give it a go.

@nandahkrishna
Copy link
Member Author

nandahkrishna commented Feb 20, 2021

Thanks everyone!

Update: First run

@nandahkrishna nandahkrishna merged commit cdaf5cc into Homebrew:master Feb 20, 2021
@nandahkrishna nandahkrishna deleted the automate-brew-man branch February 20, 2021 15:16
@BrewTestBot BrewTestBot added the outdated PR was locked due to age label Mar 23, 2021
@Homebrew Homebrew locked as resolved and limited conversation to collaborators Mar 23, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants