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.

Sign up for GitHub

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

[Penify]: Setting up Automated AI-Driven Documentation for GitHub! #74

Closed
wants to merge 2 commits into from
Closed

[Penify]: Setting up Automated AI-Driven Documentation for GitHub! #74

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4039a3e
Penify config file
penify-dev[bot] Jan 20, 2025
afffced
Merge branch 'main' into penify/config_bb04e
gstraccini[bot] Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/snorkell-auto-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# This workflow will improvise current file with AI genereated documentation and Create new PR

name: Penify - Revolutionizing Documentation on GitHub

on:
push:
branches: ["main"]
workflow_dispatch:

jobs:
Documentation:
runs-on: ubuntu-latest
steps:
- name: Penify DocGen Client
uses: SingularityX-ai/snorkell-documentation-client@v1.0.0

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action 'Penify - Revolutionizing Documentation on GitHub' step
Uses Step
Loading
uses 'SingularityX-ai/snorkell-documentation-client' with ref 'v1.0.0', not a pinned commit hash
with:
client_id: ${{ secrets.SNORKELL_CLIENT_ID }}
api_key: ${{ secrets.SNORKELL_API_KEY }}
branch_name: "main"
Comment on lines +12 to +19

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions Job or Workflow does not set permissions
Loading