Skip to content

Generate complete English release notes - #1

Open
diegoabadan wants to merge 1 commit into
mainfrom
improve/complete-english-releases
Open

Generate complete English release notes#1
diegoabadan wants to merge 1 commit into
mainfrom
improve/complete-english-releases

Conversation

@diegoabadan

Copy link
Copy Markdown
Member

Targets

  • Application and version: reusable GitHub Actions workflow for Lepidus PKP plugins
  • Base and change branches: main <- improve/complete-english-releases
  • Validation checkout: /tmp/github-workflows-release-notes-20260819

Behavior

  • Problem: consumer plugins duplicated release-note logic or published incomplete/non-English release descriptions.
  • Expected result: the reusable workflow validates version.xml exactly, creates a runtime-only package, and publishes an English release with compatibility, generated changes, and installation sections.
  • Affected surfaces: reusable workflow contract, release packaging, release descriptions, workflow validation, and multilingual documentation.

Existing callers that only pass plugin_name remain compatible. The new pkp_application, compatible_versions, and release_branch inputs are optional for migration safety; when omitted, the release explicitly reports that the value was not specified instead of inventing metadata.

Validation

  • Focused contract fixtures
  • Workflow syntax and shell validation
  • Runtime package simulation with similarTitlesReport
  • Independent Sol-agent review
  • Pull Request checks

Commands and results:

  • actionlint: passed for both workflows.
  • Exact version fixture: accepted v1.2.3.4 for release 1.2.3.4 and rejected v1.2.3.
  • Release-note fixture: matched the expected English Compatibility, Changes, and Installation sections.
  • Package fixture: preserved required runtime files and excluded tests, CI, agent metadata, and development resources.
  • Documentation checks: English is canonical; Brazilian Portuguese and Spanish links and input descriptions are consistent.

Compatibility and security

  • Public consumers examined: doiInSummary, scieloSubmissionsReport, plaudit, contentAnalysis, pluginUpdateNotification, languageToggleByFlag, scieloTheme, plauditPreEndorsement, referencesForChapters, selectionOfReviewingInterests, similarTitlesReport, and repec.
  • Existing plugin_name-only calls remain valid.
  • actions/checkout, softprops/action-gh-release, and the actionlint container are pinned by immutable SHA/digest.
  • External values are passed through environment variables and fixed printf formats.
  • Residual migration work: consumers should pass the three compatibility inputs to replace explicit Not specified fallbacks with accurate metadata.

Release

  • No version.xml, package, or tag is required for this workflow repository change.
  • After merge, consumers can adopt accurate release metadata without duplicating release-generation logic.

Centralize compatibility metadata, generated changes, installation guidance, exact version validation, and runtime-only packaging in the reusable workflow.

Keep existing callers compatible, make English the canonical README, pin CI dependencies, and validate workflows with actionlint.

Reviewed independently by a Sol agent.
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.

1 participant