actions/update-docs
actions/update-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: fix: descriptive issue titles and explicit Closes #N for all paths (03/10) #2

New issue
Closed
opened 2026-03-10 15:53:01 -07:00 by forgejo-actions · 2 comments
forgejo-actions commented 2026-03-10 15:53:01 -07:00
Copy link

@intern — Recent changes have been pushed to this repository. Please review the following documentation and update if needed.

Files to Review

  • README.md

Recent Changes (since 2026-03-10)

Commits:
a0d17fa fix: descriptive issue titles and explicit Closes #N for all paths

Changed files:
action.yml

Instructions

  1. Review each documentation file against the recent changes
  2. Check for: outdated instructions, missing features, incorrect examples, broken references
  3. If updates are needed, commit and push your changes directly to the main branch. Include Closes #2 in your commit message so this issue auto-closes.
  4. If documentation is current: comment explaining no changes needed
@intern — Recent changes have been pushed to this repository. Please review the following documentation and update if needed. ### Files to Review - `README.md` ### Recent Changes (since 2026-03-10) **Commits:** a0d17fa fix: descriptive issue titles and explicit Closes #N for all paths **Changed files:** action.yml ### Instructions 1. Review each documentation file against the recent changes 2. Check for: outdated instructions, missing features, incorrect examples, broken references 3. If updates are needed, commit and push your changes directly to the `main` branch. Include `Closes #2` in your commit message so this issue auto-closes. 4. If documentation is current: comment explaining no changes needed
intern was assigned by forgejo-actions 2026-03-10 15:53:01 -07:00
intern commented 2026-03-10 15:53:57 -07:00
Collaborator
Copy link

Documentation Review: No Updates Needed

Reviewed commit a0d17fa against README.md.

Changes Made

  • Issue titles now use first commit subject + short date (more descriptive, easier to scan)
  • Direct-push mode now uses Closes #N in commit messages (consistent with PR mode auto-close behavior)
  • Body patch logic fixed to run for all workflow modes

Assessment

No README updates required. These changes improve internal implementation details that are not (and should not be) documented in the README:

  • The README doesn't specify issue title format — it describes high-level behavior ("creates a structured issue")
  • The README doesn't quote exact instruction text — it says "agent takes over" and describes what the agent does
  • User-facing behavior is unchanged: same inputs, same trigger types, same core functionality

The improvements make the action more user-friendly (descriptive titles) and more consistent (unified auto-close behavior), but don't change the documented interface or behavior.

Status: Documentation is current. Closing issue.

## Documentation Review: No Updates Needed Reviewed commit `a0d17fa` against `README.md`. ### Changes Made - Issue titles now use first commit subject + short date (more descriptive, easier to scan) - Direct-push mode now uses `Closes #N` in commit messages (consistent with PR mode auto-close behavior) - Body patch logic fixed to run for all workflow modes ### Assessment **No README updates required.** These changes improve internal implementation details that are not (and should not be) documented in the README: - The README doesn't specify issue title format — it describes high-level behavior ("creates a structured issue") - The README doesn't quote exact instruction text — it says "agent takes over" and describes what the agent does - User-facing behavior is unchanged: same inputs, same trigger types, same core functionality The improvements make the action more user-friendly (descriptive titles) and more consistent (unified auto-close behavior), but don't change the documented interface or behavior. **Status:** Documentation is current. Closing issue.
intern commented 2026-03-10 15:54:17 -07:00
Collaborator
Copy link

Plan

Reviewed commit a0d17fa. The action.yml now:

  • Uses descriptive issue titles (first commit subject + MM/DD)
  • Instructs direct-push mode to include Closes #N in commit messages
  • Patches issue body for both PR and direct-push modes

README.md needs updates to reflect these changes. Will add:

  1. Issue title format documentation
  2. Auto-close behavior for both workflow modes
  3. Update examples/trigger table if needed

Starting now.

## Plan Reviewed commit a0d17fa. The action.yml now: - Uses descriptive issue titles (first commit subject + MM/DD) - Instructs direct-push mode to include `Closes #N` in commit messages - Patches issue body for both PR and direct-push modes README.md needs updates to reflect these changes. Will add: 1. Issue title format documentation 2. Auto-close behavior for both workflow modes 3. Update examples/trigger table if needed Starting now.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
v1
Labels
Clear labels   
update-docs

Automated documentation review

No labels
update-docs
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
intern
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
actions/update-docs#2
No description provided.