Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 2.57 KB

README.md

File metadata and controls

84 lines (57 loc) · 2.57 KB
Raw

Taymyr GitHub integration

This repository contains a few configurations of GitHub features. For example a Reusing workflows or a Release Drafter.

Release Drafter

See also documentation.

How to use:

Create a .github/workflows/release-drafter.yml in the repository with the following:

name: Release Drafter

on:
  push:
    branches:
      - main

jobs:
  update_release_draft:
    runs-on: ubuntu-latest
    steps:
      - uses: release-drafter/release-drafter@v5
        with:
          name: "<Module name> $RESOLVED_VERSION"
          config-name: release-drafts/patch-version.yml # located in .github/ in the default branch within this or the .github repo
          commitish: ${{ github.ref_name }}
          header: |
            Optional parameter. Use it if you want to prepend information above the release notes.  
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

As value of config-file parameter you can use the next variants:

  • release-drafts/patch-version.yml
  • release-drafts/minor-version.yml
  • release-drafts/major-version.yml

Reusing Workflows

See also documentation.

Mark Pull Request as Ready To Merge

This workflow is used for mark pull request as ready to merge and should be last in the workflows chain.

⚠️ For using this workflow don't forget to configure the needs (GA docs) attribute to make this workflow run last.

Path: workflows/rtm.yml

Image: Ubuntu 20.04

No Parameters

How to use:

needs: # Should be latest
  - "check-code-style"
  - "..."
  - "tests"
uses: taymyr/.github/.github/workflows/rtm.yml@v1

Sync Labels

Configuration of labels synchronize to all organization repositories by Label Sync action.

Path: workflows/sync-labels.yml

Image: Ubuntu 20.04

No Parameters

How to use:

uses: taymyr/.github/.github/workflows/sync-labels.yml@v1