Weekend Push Guardian

Block client-side git push to INPUT_GIT_PROTECTED_BRANCHES listed branches on Friday or weekend days

---

• ⬆️ Top of Document
• 🏗️ Requirements
• ⚡ Quick Start
• 🧰 Usage
• 🗒 Notes
  • Git Hooks
• 📈 Contributing
  • 🔱 Forking
  • 💱 Sponsor
• 📇 Attribution
• ⚖️ Licensing

---

Requirements

NodeJS dependencies may be installed via NPM...

npm install

---

Quick Start

Usage

Reference the code of this repository within your own workflow...

name: Weekend Push Guardian

on:
  push:


jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source branch for building Pages
        uses: actions/checkout@v4
        with:
          fetch-depth: 10

      - name: Weekend Push Guardian
        id: weekend-push-guardian
        uses: gha-utilities/[email protected]
        with:
          git_protected_branches: 'main,master'

      - name: Enjoy your weekend
        if: steps.weekend-push-guardian.outputs.passed != 'true'
        run: |
          echo "Go touch grass!"

      - name: Get stuff done on weekdays
        if: steps.weekend-push-guardian.outputs.passed && success()
        run: |
          echo "Do things on weekdays"

---

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

---

Git Hooks

For that want to mitigate pushing to GitHub on Friday or weekend days in the first place, this repository also provides Git Hooks written in pure Bash script for client, and private server(s)! Simply clone this repository and consult the official Git documentation for how to use;

• hooks/pre-push documentation: man --pager='less --pattern="^\s+pre-push"' githooks
• hooks/pre-receive documentation: man --pager='less --pattern="^\s+pre-receive"' githooks

---

Contributing

Options for contributing to weekend-push-guardian and gha-utilities

---

Forking

Start making a Fork of this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is [email protected]:<NAME>/<REPO>.git...

cd ~/git/hub/gha-utilities/weekend-push-guardian

git remote add fork [email protected]:<NAME>/weekend-push-guardian.git

• Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/gha-utilities/weekend-push-guardian


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push -u fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

---

Sponsor

Thanks for even considering it!

Via Liberapay you may on a repeating basis.

Regardless of if you're able to financially support projects such as weekend-push-guardian that gha-utilities maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.

---

Attribution

• GitHub -- github-utilities/make-readme

---

License

Block client-side `git push` to `INPUT_GIT_PROTECTED_BRANCHES` listed branches on Friday or weekend days
Copyright (C) 2024 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.