Update README.md #22
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Ponicode DogString | |
| # Controls when the action will run. Triggers the workflow on push or pull request | |
| # events but only for the master branch | |
| on: | |
| push: | |
| branches: [master] | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains a single job called "build" | |
| build: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| fetch-depth: 0 | |
| - name: Get paths | |
| run: | | |
| git show --pretty="" --name-only ${{ github.sha }} > PATHS_TO_CHANGED_FILES.txt | |
| - uses: ponicode/docstrings-action@master | |
| with: | |
| repo_path: ./ | |
| auth_token: ${{ secrets.PONICODE_TOKEN }} | |
| all_repo: True | |
| # Creates pull request with all changes in file | |
| - name: Create Pull Request | |
| uses: peter-evans/create-pull-request@v2 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| commit-message: "[ponicode-pull-request] Ponicode wrote new docstrings!" | |
| branch: ponicode-docstring | |
| title: "[Ponicode] Docstrings created" | |
| body: | | |
| ## ⭐️ Ponicode report ⭐️ | |
| Ponicode found **undocumented functions** in your code, and auto-generated docstrings for you. | |
| </br> | |
| ### 🦄 We'd love to hear your feedback!🦄 | |
| Send us an email at <feedback@ponicode.com>, open an issue on our Action, or join us on the [Ponicode Community Slack](https://ponicode-community.slack.com/join/shared_invite/zt-fiq4fhkg-DE~a_FkJ7xtiZxW7efyA4Q#/). | |
| Visit **[ponicode.com](https://ponicode.com)** to find out more about what we do. | |
| </br> | |
| <img alt="Ponicode Logo" src="https://avatars0.githubusercontent.com/u/49948625?s=200&v=4=200zx" width="100"/> |