Template for pull request reviews - github

GitHub allows for creating PR templates. Is it possible to do the same, but for pull request reviews?
An example of such would be adding a review checklist, like the following:
- [] Have all the GitHub checks passed?
- [] Is there any redundant code?
- [] Could any optimization be applied?


In GitHub, there are no templates for pull request reviews. And, this makes sense, because reviews directly belong to pull requests.
But you can run a GitHub action when a draft PR is changed to the ready for review state, for example with:
on:
pull_request_target:
types:
- ready_for_review
To create a comment with checkboxes in this step, use marocchino/sticky-pull-request-comment.
I have tested it in this PR and I am excited about how well this is working.
Full example:
name: "Pull request checklist"
on:
pull_request_target:
types:
- ready_for_review
jobs:
pull_request_info:
runs-on: ubuntu-latest
steps:
- name: Extract branch name
shell: bash
run: echo "##[set-output name=branch;]$(echo ${GITHUB_HEAD_REF})"
id: extract_branch
- name: Checkout repository
uses: actions/checkout#v3
with:
fetch-depth: 0
- name: Show checklist
uses: marocchino/sticky-pull-request-comment#v2
with:
header: show_checklist
message: |
- [ ] Checklist item 1
- [ ] Checklist item 2
For more options, check out the:
Sticky pull request comment repo
GitHub actions workflow events documentation

Related

Auto-approve not automatically merged in GitHub

I have a GitHub workflow where a PR is created each day to update some dependencies.
The problem is that I have to merge it manually. The PR gets an auto-approve tag.
Next I can click "Merge pull request". If I go to settings > branches > main > and I enable require approvals (1). Then I can enable "Auto-merge" for the repo. But it does not fully merge since it requires an approval. So I have to turn it off again.
I'm not sure how this flow is working. I just want that it gets merged automatically. In my settings I have already enabled "Allow auto-merge".
This is a part of my upgrade-main.yml.
- name: Create Pull Request
id: create-pr
uses: peter-evans/create-pull-request#v3
with:
token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
commit-message: |-
chore(deps): upgrade dependencies
Upgrades project dependencies. See details in [workflow run].
[Workflow Run]: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
------
*Automatically created by projen via the "upgrade-main" workflow*
branch: github-actions/upgrade-main
title: "chore(deps): upgrade dependencies"
labels: auto-approve
body: |-
Upgrades project dependencies. See details in [workflow run].
[Workflow Run]: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
------
*Automatically created by projen via the "upgrade-main" workflow*
author: github-actions <github-actions#github.com>
committer: github-actions <github-actions#github.com>
signoff: true

How to access a multi branch resource attribute in a concourse job?

I'm using multi branch resourcing in a concourse pipeline like so:
resources:
- name: my-resource
type: git-multibranch
source:
uri: git#github.com.../my-resource
branches: 'feature/.*'
private_key: ...
ignore-branches: ''
How can I access the branch the resource is on at the time the job runs? like so:
jobs:
...
outputs:
- name: my-resource
params:
GIT_BRANCH: {BRANCH-GOES-HERE}
I'm looking to access it via something like my-resource.branch but haven't found any thing that works yet

Github Actions CI: Not running on push for feature branches

I am following this tutorial to run my unit tests on Github. I have it on both master and feature branch, but it's not firing when I push to the feature branch.
on:
push:
branches:
- '*'
- '!master'
- '!release*'
However if I follow the cron-based example from the docs:
on:
schedule:
- cron: '0 * * * *'
It will run but I want this to be for pull requests.

I found the answer here:
on:
push:
# Sequence of patterns matched against refs/heads
branches-ignore:
- master
- release*

How to have event configuration with string for GitHub Actions On?

I have the following GitHub Actions YML file.
name: CI
on:
- push
- release:
- types: [published]
#...
But I'm getting an error: Invalid Workflow File Invalid type for on.
The only other way to do what I want here is to do on: [push, release]. But then I can't filter by type published.
How can I fix this error?

The yaml doesn't look valid to me. Try this:
name: CI
on:
push:
release:
types: [published]

Is there a way to put a lock on Concourse git-resource?

I have setup pipeline in Concourse with some jobs that are building Docker images.
After the build I push the image tag to the git repo.
The problem is when the builds come to end at the same time, one jobs pushes to git, while the other just pulled, and when second job tries push to git it gets error.
error: failed to push some refs to 'git#github.com:*****/*****'
hint: Updates were rejected because the remote contains work that you do
hint: not have locally. This is usually caused by another repository pushing
hint: to the same ref. You may want to first integrate the remote changes
hint: (e.g., 'git pull ...') before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.
So is there any way to prevent concurrent push?
So far I've tried applying serial and serial_groups to jobs.
It helps, but all the jobs got queued up, because we have a lot of builds.
I expect jobs to run concurrently and pause before doing operations to git if some other job have a lock on it.
resources:
- name: backend-helm-repo
type: git
source:
branch: master
paths:
- helm
uri: git#github.com:******/******
-...
jobs:
-...
- name: some-hidden-api-build
serial: true
serial_groups:
- build-alone
plan:
- get: some-hidden-api-repo
trigger: true
- get: golang
- task: build-image
file: somefile.yaml
- put: some-hidden-api-image
- get: backend-helm-repo
- task: update-helm-tag
config:
platform: linux
image_resource:
type: registry-image
source:
repository: mikefarah/yq
tag: latest
run:
path: /bin/sh
args:
- -xce
- "file manipulations && git commit"
inputs:
- name: some-hidden-api-repo
- name: backend-helm-repo
outputs:
- name: backend-helm-tag-bump
- put: backend-helm-repo
params:
repository: backend-helm-tag-bump
- put: some-hidden-api-status
params:
commit: some-hidden-api-repo
state: success
- name: some-other-build
serial: true
serial_groups:
- build-alone
plan:
- get: some-other-repo
trigger: true
- get: golang
- task: build-image
file: somefile.yaml
- put: some-other-image
- get: backend-helm-repo
- task: update-helm-tag
config:
platform: linux
image_resource:
type: registry-image
source:
repository: mikefarah/yq
tag: latest
run:
path: /bin/sh
args:
- -xce
- "file manipulations && git commit"
inputs:
- name: some-other-repo
- name: backend-helm-repo
outputs:
- name: backend-helm-tag-bump
- put: backend-helm-repo
params:
repository: backend-helm-tag-bump
- put: some-other-status
params:
commit: some-other-repo
state: success
-...
So if jobs come finish image build at the same time and make git commit in parallel, one pushes faster, than second one, second one breaks.
Can someone help?

note that your description is too vague to give detailed answer.
I expect jobs to concurrently and stop before pushing to git if some other job have a lock on git.
This will not be enough, if they stop just before pushing, they are already referencing a git commit, which will become stale when the lock is released by the other job :-)
The jobs would have to stop, waiting on the lock, before cloning the git repo, so at the very beginning.
All this is speculation on my part, since again it is not clear what you want to do, for these kind of questions posting a as-small-as-possible pipeline image and as-small-as-possible configuration code is helpful.
You can consider https://github.com/concourse/pool-resource as locking mechanism.