Skip to content

Fix docs.zip case inconsistency in release workflow#18

Draft
Copilot wants to merge 6 commits intomainfrom
copilot/sub-pr-17
Draft

Fix docs.zip case inconsistency in release workflow#18
Copilot wants to merge 6 commits intomainfrom
copilot/sub-pr-17

Conversation

Copy link
Copy Markdown

Copilot AI commented Feb 21, 2026

release.yml referenced Docs.zip (capital D) as the documentation upload asset, but the documentation is generated into docs/ (lowercase) and no step ever created Docs.zip — causing the upload step to silently fail on every release.

Description

  • Added a "Create documentation archive" step (zip -r docs.zip docs/) after documentation generation, with continue-on-error: true to keep docs optional
  • Changed asset_path from ./Docs.zip./docs.zip
  • Changed asset_name from Docs-${{ github.ref_name }}.zipdocs-${{ github.ref_name }}.zip

All three references (docs/ output path, docs.zip archive, and the release notes download link) are now consistent.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring
  • Performance improvement
  • Test addition/modification
  • CI/CD changes

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Testing

  • Manual testing — verified workflow YAML is syntactically valid and asset paths match the generated artifact name

Additional Notes

The continue-on-error: true is intentionally preserved on both the generate and archive steps — documentation is best-effort and should not block a release.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.


Continue Tasks: ❌ 3 failed — View all

dragosv and others added 5 commits February 21, 2026 09:13
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI mentioned this pull request Feb 21, 2026
Base automatically changed from docs to main February 21, 2026 08:13
Co-authored-by: dragosv <422243+dragosv@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation based on feedback from PR #17 Fix docs.zip case inconsistency in release workflow Feb 21, 2026
Copilot AI requested a review from dragosv February 21, 2026 08:15
@codacy-production
Copy link
Copy Markdown

Codacy's Analysis Summary

57 new issues (≤ 0 issue)
0 new security issue
10 complexity
0 duplications

Review Pull Request in Codacy →

AI Reviewer available: add the codacy-review label to get contextual insights without leaving GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants