Keep workflows active #293

Activity

1. drewoldag commented on Nov 17, 2023

   

   drewoldag

   on Nov 17, 2023

   Collaborator

   More actions

   Long term maintainability is one of the selling points for using the Python Project Template. We should really try to find a way to keep the smoke test active in the long term.
2. drewoldag

   added this to the Release tag 2.0 milestone on Feb 1, 2024
3. drewoldag

   self-assigned this

   on Feb 1, 2024
4. drewoldag commented on Feb 1, 2024

   

   drewoldag

   on Feb 1, 2024

   Collaborator

   More actions

   https://docs.github.com/en/actions/using-workflows/disabling-and-enabling-a-workflow?tool=webui
5. drewoldag commented on Feb 1, 2024

   

   drewoldag

   on Feb 1, 2024

   Collaborator

   More actions

   I've looked around, and it seems like the correct path forward that would allow users to be pretty long term hands off would be use a github action that pushes an empty commit to the repo.

   The github action mentioned in the first comment seems to be the most popular one that I've been able to find after searching around in the marketplace. Though to be fair, it's hard to find anything there.

   I've run some tests in my personal repo, and it seems ok. It does require the user to set a particular repository setting, which is just one more thing that a user has to do to get up and running.

   Aside from that though, inserting it into the smoke-test.yml file would be fairly straightforward.

   name: Unit test smoke test
   
   on:
   
     # Runs this workflow automatically
     schedule:
       - cron: 45 6 * * *
       
     # Allows you to run this workflow manually from the Actions tab
     workflow_dispatch:
   
   jobs:
     build:
   
       runs-on: ubuntu-latest
       strategy:
         matrix:
           python-version: ['3.8', '3.9', '3.10']
   
       steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           sudo apt-get update
           python -m pip install --upgrade pip
           pip install .
           pip install .[dev]
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
       - name: List dependencies
         run: |
           pip list
       - name: Run unit tests with pytest
         run: |
           python -m pytest
       - uses: gautamkrishnar/keepalive-workflow
         with:
           commit_message: Keeping project active with empty commit
           committer_username: keep-alive-bot
           committer_email: {user_email} # taken from the copier answers
   
6. delucchi-cmu

   removed this from the Release tag 2.0 milestone on Feb 2, 2024
7. hombit commented on Feb 4, 2024

   

   hombit

   on Feb 4, 2024

   Contributor

   More actions

   GitHub sends an email before disabling smoke tests, and this email has a big green link to a page with "Continue running workflow" button. Of course it is still easy to miss the email, but I believe it is not as bad as we expected it to be
8. drewoldag

   removed their assignment

   on Feb 9, 2024
9. delucchi-cmu

   added

   enhancementNew feature or requestNew feature or request

   on Feb 26, 2024