tmillr / breaking-change Goto Github PK

• Split tests into unit and integration suites
  • use Codecov "flags" for splitting coverage reports
  • use separate scripts for each kind of test (e.g. integration, unit) so they can be run separately and their output won't be intermixed
• Refactor test utils into their own files

Not part of the spec and not sure how common it is used, but...

Pros

• No more build step (unless another compile-time tool such as Terser or TypeScript is introduced later on)
• All deps are committed and tracked in the repo
  • No need to run npm ci every time you test or switch a branch?
  • No need to worry about node_modules becoming out of sync when checking-out commits/branches
  • Better and more efficient than committing node_modules, although that's not being done currently anyway
• Experience using/understanding yarn cache

Cons

• Larger repo size (although e.g. git checkout action only clones a branch's HEAD commit by default instead of the entire history...assuming custom actions are cloned similarly? i.e. shallowly)
• Compatibility (especially dev deps, IDE tools/integration)
• More complicated usage/setup/config, more complicated than ncc and npm

Alternatively use pnpm for quicker and more efficient clean installs...still need bundler/ncc though, and pnpm has its own set of compat issues (although they can be worked-around).

or, allow the user to pass a template string via action inputs describing the comment to post

For potential usage beyond mere push events?

Only push is supported currently. Other events are ignored and the action exits early with 0.

The same commit might get reported more than once (e.g. a tag gets pushed, the same commit is pushed to multiple branches, etc.).

It appears that a separate workflow run occurs for each pushed tag. I assume that the commits array of the event/webhook payload will be empty if the tagged commit already exists on GitHub? but not if gh does not already have the commit that the pushed tag points to? if this is the case, then it probably shouldn't be necessary to ignore pushed tags in hopes of avoiding duplicate reports due to breaking change seeing the same commit twice or more (once for the pushed commit workflow run, and once for each pushed tag that points to that commit).

Potential Fixes

• use a cache to note which commits have already been reported
• warn users of this in docs/readme
• investigate what happens when a tag gets pushed, how to avoid/ignore push events for tags

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: .github/renovate.json5
Error type: The renovate configuration file contains some invalid settings
Message: node.packageRules[0]: Each packageRule must contain at least one match* or exclude* selector. Rule: {"allowedVersions":"^16.0.0"}

It's probably not a huge issue (integration or end-to-end tests should determine if it is) as we're not publishing a library (whose code could be further used/bundled downstream). I heard that it might cause an issue on Nodejs on Linux however.

Ideas For Fix

Either don't bundle (which is what creates the mixed line-endings), or use a tool post-bundle to convert all line-endings to LF. One idea is to use Terser, which will also potentially minify, as well and provide a final source map (useful for coverage reports). Terser will parse into AST and then emit all LF line-endings. Parsing into AST instead of blindly replacing all CRLF with LF is better as it is possible (I think) for there to be CRLF in positions other than source code line endings (e.g. maybe a string literal could contain one).

Why?

• to make sure that action.yml is still valid on and into the future (e.g. its schema may change, the chosen/selected node version may become outdated/invalid, etc.)
• to make sure the action does not break when the gh runners (or their interface with js actions) change
• for end-to-end testing, if wanted or needed
• provides a way to capture/view the action's actual output from an actual/realistic run (e.g. for #1)

How?

• create a scratch branch or scratch repo for pushing test commits to
  • if branch, the ci yaml itself must still be on the default branch
• choose any events necessary, but also at least run on a schedule (e.g. daily) since it's possible for this action (or its manifest: action.yml) to break even if the pkg/repo itself doesn't actually change
• observe workflow runs for failures, esp those due to an invalid action.yml. This can also be used as a way to verify that the action.yml is (still) valid before releasing/tagging new versions.
  • can use gh api to retrieve workflow run results
  • can view results manually in browser anywhere workflow run results are displayed (e.g. Actions tab, commit list/history, branch landing page, pr checks), or in user notifications (if configured)
  • maybe auto-open an issue or pr on failure for extra visibility

NOTE: remember that pushing commits from within gh actions/ci will not trigger further events/workflows unless pushed using a custom token/pat

such as renovate or dependabot

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/setup-node action to v4
• chore(deps): update codecov/codecov-action action to v4
• chore(deps): update dependency npm to v10
• chore(deps): update peter-evans/create-pull-request action to v6
• chore(deps): update dependency ava to v6
• chore(deps): update dependency c8 to v9
• chore(deps): update dependency execa to v9
• chore(deps): update node.js to v20
• 🔐 Create all rate-limited PRs at once 🔐

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• chore(deps): roll back tmillr/breaking-change action to v1.0.1

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency @vercel/ncc to v0.38.1
• chore(deps): update dependency execa to v7.2.0
• chore(deps): update dependency npm to v9.9.3
• chore(deps): update dependency semver to v7.6.2
• chore(deps): update node.js to v16.20.2
• chore(deps): update dependency prettier to v3
• fix(deps): update dependency @actions/core to v1.10.1
• fix(deps): update dependency @actions/github to v6
• chore(deps): lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository