Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: use pull request on for doc update instead of directly committing. #9

Open
1 task done
s1n7ax opened this issue Nov 10, 2023 · 0 comments
Open
1 task done
Labels
enhancement New feature or request

Comments

@s1n7ax
Copy link

s1n7ax commented Nov 10, 2023

Did you check the docs?

  • I have read all the docs

Is your feature request related to a problem? Please describe.

Why?

  • Adding permission to create a pull request is easy
  • Bot directly committing to main doesn't sound good
  • It's better to review before merging

Describe the solution you'd like

This is what I'm using to create a pull request to update the vimdoc

on:
  push:
    branches:
      - main

name: docs

permissions:
  pull-requests: write
  contents: write

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: panvimdoc
        uses: kdheepak/panvimdoc@main
        with:
          vimdoc: "<name>"
          dedupsubheadings: false
          version: "Neovim >= 0.9.4"
          demojify: true

      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v5
        with:
          base: "main"

Describe alternatives you've considered

.

Additional context

No response

@s1n7ax s1n7ax added the enhancement New feature or request label Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant