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.

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

Would it be possible to add a changelog for each package? #913

Open
tobiasbueschel opened this issue Dec 17, 2024 · 3 comments
Open

Would it be possible to add a changelog for each package? #913

tobiasbueschel opened this issue Dec 17, 2024 · 3 comments

Comments

@tobiasbueschel
Copy link

It would be great if we could add a changelog.md to each of the packages and also detail the package changelog in each GitHub release and tag that is pushed to this monorepo.

For context:

  • Various packages were recently updated such as office-addin-debugging to v6.0.1 and office-addin-manifest to v2.0.1
  • I was trying to find the changelog for each of updates made in the respective package so that I could understand what impact it would have if I were to update these packages to the latest version
  • One could go through the commit history, but that's not ideal

Potential solutions
There are some off-the-shelf tools available for automatically updating monorepo packages semantic versions based on conventional commits

@tobiasbueschel
Copy link
Author

I've tried to upgrade to v6.0.1 of the office-addin-debugging package, but now receive the following error:

> [email protected] ostop /Users/tobias/demo-project
> office-addin-debugging stop manifest.xml

/Users/tobias/demo-project/node_modules/.pnpm/[email protected]_@[email protected][email protected]/node_modules/office-addin-debugging/lib/defaults.js:11
exports.usageDataObject = new office_addin_usage_data_1.default.OfficeAddinUsageData({
                                                                ^

TypeError: Cannot read properties of undefined (reading 'OfficeAddinUsageData')
    at Object.<anonymous> (/Users/tobias/demo-project/node_modules/.pnpm/[email protected]_@[email protected][email protected]/node_modules/office-addin-debugging/lib/defaults.js:11:65)
    at Module._compile (node:internal/modules/cjs/loader:1546:14)
    at Object..js (node:internal/modules/cjs/loader:1698:10)
    at Module.load (node:internal/modules/cjs/loader:1303:32)
    at Function._load (node:internal/modules/cjs/loader:1117:12)
    at TracingChannel.traceSync (node:diagnostics_channel:322:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:218:24)
    at Module.<anonymous> (node:internal/modules/cjs/loader:1325:12)
    at Module.patchedRequire [as require] (/Users/tobias/demo-project/node_modules/.pnpm/[email protected]/node_modules/diagnostic-channel/dist/src/patchRequire.js:14:46)
    at require (node:internal/modules/helpers:136:16)

Node.js v23.3.0
 ELIFECYCLE  Command failed with exit code 1.
 ```
 
 Would you mind pointing me to what changed? :) 

@millerds
Copy link
Contributor

Thanks for the suggestion on the release notes. Those suggested package don't fit within our current process, but our process could use some refinement, so we'll have to consider those libraries.

The last major version bump of these packages was due to a restructuring of many of the typescript configuration controlling the build process. They have not been pushed as the latest packages because they still need to go through some validation with some test projects to make sure some something else hasn't broken. If I had to wager a guess, I'd say either you don't have the updated OfficeAddinUsageDate and it's needed (though I'm not sure why) or something did break between OfficeAddinUsageData and OfficeAddinDebugging.

Could you try installing the "next" version of OfficeAddinUsageData directly in your project and see if you get different behavior?

@millerds
Copy link
Contributor

Actually . . . that won't work. Looks like the generated import statement (typescript to js in the package) changed when the typescript build confg was updated and that is not working even though the updated office-addin-usage-data package is installed. This is a bug in the packages that needs to get fixed before making these versions the "latest" versions.

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

No branches or pull requests

2 participants