Improve Pull Request Action behavior

The pull-request.yaml Action may not need to trigger the code checks and tests:

python-package-template/.github/workflows/pull-request.yaml

Lines 57 to 61 in f41b0e6

    
           build: 
        
             needs: conventional-commits 
        
             uses: ./.github/workflows/build.yaml 
        
             permissions: 
        
               contents: read

if the PR is in “draft” mode — the event payload has a boolean "draft":

build: 
  needs: conventional-commits 
  if: ${{ !github.event.pull_request.draft }}

that we should be able to check. A draft PR by definition is incomplete and may or may not pass checks and tests…

Furthermore, I am tempted to change this

python-package-template/.github/workflows/pull-request.yaml

Lines 8 to 11 in f41b0e6

    
           pull_request: 
        
             branches: 
        
             - main 
        
             - staging

to

 pull_request: 
   branches: 
   - *

to target all PRs regardless of their base branch (i.e. PRs that target other PRs).

We also don’t need to run checks and tests if the PR body discussion has had an entry but there was no code change. In that case, maybe only run cz (because the PR title was changed), for example:

build: 
  needs: conventional-commits 
  if: ${{ github.event.action !== 'edited' }}

Skipping the build job, however, means that no artifacts are produced by that particular Action run, which is probably acceptable.

@behnazh

@behnazh I think we can close this one now? Two related issues are merged.

It would make sense, methinks, to expand the PR Action to check that a PR does not modify certain files. These “protected” files could be stored in the repository in a dedicated dot-file, e.g. .donottouch.

The intention is to prevent people from modifying these files in downstream repositories, and enforce modifying these files in the parent template repository. Protected files would be e.g. the Makefile or .pre-commit-config.yaml.

(Related issue #370.)

Navigation Menu

Repository navigation

Improve Pull Request Action behavior #330

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

	build:
	needs: conventional-commits
	uses: ./.github/workflows/build.yaml
	permissions:
	contents: read

Improve Pull Request Action behavior #330

Description

Activity

jenstroeger commented on Oct 28, 2022

jenstroeger commented on Nov 2, 2022

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions