Add changelog updating #23
Conversation
rekmarks
force-pushed
the
changelog-updating
branch
from
af9b7c6 to
56af347
Compare
| { | ||
| files: ['**/*.d.ts'], | ||
| rules: { | ||
| 'import/unambiguous': 'off', |
There was a problem hiding this comment.
Wait, on type definitions!? How does this rule apply to those 😕
There was a problem hiding this comment.
Well, I've looked into this, but I am still confused. No update. Welp.
I'm OK to let this slide for now but I still suspect we're doing something wrong.
There was a problem hiding this comment.
I think it makes sense given the documentation of import/unambiguous: https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/unambiguous.md
And indeed, using parserOptions: { sourceType: 'script' } } in the override works equally well. Maybe we prefer that?
There was a problem hiding this comment.
I'm not sure 🤔 I'm curious which part of the docs indicate that this makes sense 😅 That is, it's not clear to me that a type definition is a module or a script. I don't know which fits better, if either. I was hoping that the TypeScript ESLint module would make some sense from this, but no such luck.
Given my limited understanding at the moment, turning it off seems like the most sensible approach.
| * the git config remote.origin.url string matches one of: | ||
| * | ||
| * - https://github.com/OrganizationName/RepositoryName | ||
| * - [email protected]:OrganizationName/RepositoryName.git |
There was a problem hiding this comment.
Any idea when each of these are used? The @action/checkout docs indicate that github.repository is the default, but I haven't tracked down what that is yet.
There was a problem hiding this comment.
Hm, I think it's simply dictated by whether git is configured to use SSH or HTTP/HTTPS. If you search for github.repository here, you'll see that it's just OrganizationName/RepositoryName.
actions/checkout supports either HTTPS or SSH, and the one it uses is determined by the inputs you provide to it, so for present purposes I think we're good so long as we support both?
There was a problem hiding this comment.
actions/checkout supports either HTTPS or SSH, and the one it uses is determined by the inputs you provide to it
I couldn't find confirmation of this in their docs, but I found some code that indicates that this is true! https://github.com/actions/checkout/blob/main/src/url-helper.ts
src/package-operations.ts
Outdated
| const { newVersion, repositoryUrl } = updateSpecification; | ||
|
|
||
| let changelogContent: string; | ||
| const changelogPath = `${projectRootDirectory}/CHANGELOG.md`; |
There was a problem hiding this comment.
Nit: Probably better to use path.join here for Windows compatibility.
src/package-operations.ts
Outdated
| */ | ||
| function getTruncatedPath(absolutePath: string): string { | ||
| return absolutePath | ||
| .split('/') |
There was a problem hiding this comment.
Nit: we can use path.sep here for better windows support
Adds changelog updating to the package update workflow via
@metamask/auto-changelog. The action now assumes that there's a Keep-a-ChangelogCHANGELOG.mdfile at the root of every package in the repository.