Skip to content

[MOO - 2286] : Release script fixes to automate Docs and Changelog PR in NT- 19-x-x - #1273

Open
saurabhchavan1711 wants to merge 17 commits into
release/19.x.xfrom
moo/MOO-2286-docs-pr-automation-19-x-x
Open

[MOO - 2286] : Release script fixes to automate Docs and Changelog PR in NT- 19-x-x#1273
saurabhchavan1711 wants to merge 17 commits into
release/19.x.xfrom
moo/MOO-2286-docs-pr-automation-19-x-x

Conversation

@saurabhchavan1711

@saurabhchavan1711 saurabhchavan1711 commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Description

In this PR

  • Fixed the docs PR automation issues of polluted commits
  • Moved the sync job from mendixMobile/docs fork to native-template repo
  • Put publishing to docs and creating PR in native template changelog PR after release NT job , deleted the publishing changelog to docs job
  • Added logic to raise PR in NT to update changelog after successful release

Checklist

To ensure this pull request meets the requirements for merging, please complete the checklist below:

  • Release Note: As a part of the release process, an automated PR will be created for the Mendix Docs repository relevant to the changes introduced in this PR. Post release, please ensure that the release note accurately reflects the changes and impacts of this PR.
  • Breaking Changes: This PR introduces breaking changes (e.g., changes that require updates to existing configurations, dependencies).
    • If yes, I have documented these breaking changes and provided guidance for users to adapt.
    • Details about breaking changes: [Provide details here, if applicable]

This PR contains

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Other (describe)

await updateNTChangelog(changelog, unreleasedContent, changelogPath);

// Update release notes in docs repo
await updateNTReleaseNotes(unreleasedContent);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With error-handling in mind, I'm thinking what would happen in the scenario of updateNTReleaseNotes failing. From what it looks like now:

  • A draft PR in native-template is created with no corresponding docs PR.
  • On re-run, createPRUpdateChangelog() might throw ("A pull request already exists for..."), causing the entire script to fail on retry without ever reaching the docs step.

Maybe we can look into handling at least this error if it gets thrown whenever we call the pulls.create API. Ideally we can consider making the operation idempotent by editing the existing PR.

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