Skip to content

A tool for creating a code of conduct with a prefix and a patch

Notifications You must be signed in to change notification settings

pkgjs/patch-my-code-of-conduct

Folders and files

NameName
Last commit message
Last commit date

Latest commit

9651aba · Apr 27, 2023

History

36 Commits
Apr 3, 2023
Apr 3, 2023
Apr 3, 2023
Nov 11, 2022
Apr 27, 2023
Apr 3, 2023
Apr 3, 2023
Apr 3, 2023
Jan 4, 2023
Nov 11, 2022
Apr 3, 2023

Repository files navigation

Patch my Code of Conduct

This action adds a prefix to the default Code of Conduct template and applies the necessary templates.

If used with gr2m/create-or-update-pull-request-action@v1 workflow automatically creates a pull request with the applied changes.

  • Opens a pull request if output file does not exist (Example)
  • Opens a pull request if patch file is changed (Example)

Example Workflow

on: [push]

jobs:
  main_job:
    runs-on: ubuntu-latest
    name: Test Action
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          persist-credentials: false
      - name: Start Patch
        uses: pkgjs/[email protected]
        with:
          base_url: './BASE.md'
          patch_file_path: './patch'
          output_file_path: './CODE_OF_CONDUCT.md'
      - uses: gr2m/create-or-update-pull-request-action@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          body: "Applied the patch to the base Code of Conduct."
          branch: actions/patch-code-of-conduct  # Custom branch *just* for this Action.
          commit-message: 'doc: update Code of Conduct'
          title: 'doc: update Code of Conduct'

Useful Information

Generate patch file

  • Generate a premable+template.md
  • Generate a original-expected.md file
diff -Naur preamble+template.md original-expected.md > patch

Running patching script

patch -i patch preamble+template.md -o expected.md --no-backup-if-mismatch