Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 2.07 KB

README.md

File metadata and controls

71 lines (56 loc) · 2.07 KB
Raw

GitHub Pull Request Codefresh Plugin

Operates on pull requests in GitHub. You can create a pull request, update it, open or close.

Environment Variables

  • GITHUB_TOKEN: token for access to GitHub
  • GITHUB_REPO_OWNER: name of repo owner
  • GITHUB_REPO_NAME: name of repo
  • GITHUB_PR_OPERATION (default: create): operation on pull request (choices: create, update, open, close)
  • GITHUB_PR_NUMBER: number of your pull request (required for: update, open, close)
  • HEAD: The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch
  • BASE: The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.
  • TITLE: The title of the pull request

Deployment with Codefresh

  • Add encrypted environment variables for:

    • GITHUB_TOKEN

  • Add "github-pr" step as described below

# codefresh.yml example with github for pr creating step
version: '1.0'

steps:
  build-step:
    type: build
    image-name: repo/image:tag

  push to registry:
    type: push
    candidate: ${{build-step}}
    tag: ${{CF_BRANCH}}

  github-pr:
    image: codefreshplugins/github-pr-plugin
    environment:
      - GITHUB_REPO_OWNER=${{CF_REPO_OWNER}}
      - GITHUB_REPO_NAME=${{CF_REPO_NAME}}
      - BASE=master
      - HEAD=${{CF_BRANCH}}
      - TITLE=Codefresh PR for ${{CF_BRANCH}}
  • or:
# codefresh.yml example with github pr updating step
version: '1.0'

steps:
  build-step:
    type: build
    image-name: repo/image:tag

  push to registry:
    type: push
    candidate: ${{build-step}}
    tag: ${{CF_BRANCH}}

  github-pr:
    image: codefreshplugins/github-pr-plugin
    environment:
      - GITHUB_PR_OPERATION=update
      - GITHUB_PR_NUMBER=2 # your pr number here
      - GITHUB_REPO_OWNER=${{CF_REPO_OWNER}}
      - GITHUB_REPO_NAME=${{CF_REPO_NAME}}
      - TITLE=Updated title for ${{CF_BRANCH}}