My Workflow
This GitHub Action helps maintainers of open source projects go on vacation and take mental health breaks by limiting community interactions within a repository. During this time, commenting, opening issues, or creating pull requests will be limited to a defined group.
This GitHub Action avoids the 24 hour limit of the GitHub repository interactions limit feature. This makes it easier for the project maintainers and more transparent for the community.
This GitHub Action does not make any changes that would generate a commit.
This project was inspired by @mrdoob, maintainer of three.js. I started this project on September 17th based on his feature request.
I've already received some amazing feedback, which is why I decided to submit it here for more reach.
Mr.doob@mrdoob@lucasrangit @github There are two types of engineers:
The ones that point every possible flaw of an idea and do nothing.
And the ones that say nothing and send you the solution a day later.
We need more people like you π17:53 PM - 20 Sep 2020
Submission Category:
Maintainer Must-Haves
Yaml File
name: Vacation Mode
on:
# Run on all issue activity
issues:
# Run daily to reset the 24 hour interaction limit timer as needed
schedule:
- cron: "0 0 * * *"
jobs:
vacation_mode_job:
runs-on: ubuntu-latest
name: Update Vacation Mode
steps:
- uses: robotnyc/vacation-mode-action@v1
with:
limit-group: 'collaborators_only'
vacation-mode-activated: '![vacation-mode-activated](https://i.imgflip.com/18t5ch.jpg)'
GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
Code
robotnyc / vacation-mode-action
Limit interactions to your repository while on vacation using GitHub Actions
Vacation Mode JavaScript Action
This GitHub Action helps maintainers of open source projects go on vacation and take mental health breaks by limiting community interactions within a repository. During this time, commenting, opening issues, or creating pull requests will be limited to a defined group.
This GitHub Action avoids the 24 hour limit of the GitHub repository interactions limit feature. This makes it easier for the project maintainers and more transparent for the community.
This GitHub Action does not make any changes that would generate a commit.
Inspired by @mrdoob's, maintainer of three.js, feature request https://twitter.com/mrdoob/status/1305989856368234496 .
Usage
- Add the setup code to your repository workflow.
- Create an issue with a title that contains "vacation". For example, "
π΄ On Vacation Next Week". - Pin the issue to activate it and so your community can clearly see that you are on vacation.
- Include an "out-of-office note" in the issueβ¦
Top comments (1)
Some comments may only be visible to logged-in visitors. Sign in to view all comments.