Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@covector/changelog

jbolda5.5kApache-2.00.12.0TypeScript support: included

The documentation here is light, and this library serves primarily as internals to covector.

readme

The documentation here is light, and this library serves primarily as internals to covector.

changelog

Changelog

[0.12.0]

Enhancements

  • e2c83dc (#318 by @jbolda) Add exports to package.json for improved capability and an enhanced experience when developed covector and testing locally.
  • ce43ad7 (#319 by @jbolda) Add logger instance to allow custom loggers based on the usage context. It enables different structured logs for the CLI vs within a GitHub Action, as well as for local development and testing.

Dependencies

  • Upgraded to @covector/files@0.8.0

Changes Supporting Covector Development

  • ce43ad7 (#319 by @jbolda) Switch to Vitest for the test runner. This improves speed and enables improved ability to update to current standards. Additionally, we use pino-test with the changes to the logger to more specifically check log output. Along with this, we switch multiple test fixtures to run commands that would return more standard output across OS which reduces test flakiness.

[0.11.0]

  • 9202dca (#307 by @jbolda) Pass createContext function from action through to changelog to enable passing specific context usable within changelogs.
  • 9202dca (#307 by @jbolda) Query the GitHub API for the PR creator, and highlight their names in the changelogs for recognition of their contribution.

Dependencies

  • Upgraded to @covector/files@0.7.2

[0.10.1]

Dependencies

  • Upgraded to @covector/files@0.7.1

[0.10.0]

Bug Fixes

  • 48d11e3(#292) Fix detecting PR number when the merge commit contains another PR or an issue number, for example: fix: add new api, closes #123 (#225).

Dependencies

  • Upgraded to @covector/files@0.7.0

[0.9.0]

Enhancements

  • 7156ce0(#277) Add change for all exact deps rolled up to handle it with the changelog deps section. Add the version number to the changelog deps section.

Bug Fixes

  • 708adf2(#282) Fix the built-in fallback deps: Dependecies tag always appearing first in changelog when it should be the last one.
  • 828818e(#278) The changelog function to pull the last version in the changelog did not properly consider headings deeper than level 1 and level 2. When a third level was added, this caused the function to return the full changelog. Search for next heading with a specific depth of 2.

Dependencies

  • Upgraded to @covector/files@0.6.2

[0.8.0]

Dependencies

  • 7b6201c(#264) Bump Typescript to v4.9, and deeply update types in the lower level functions to start.

New Features

  • 0b33560(#244) Add changelog tags (section or category) to group different change files.

Enhancements

  • 2ba699d(#243) Update the changelog format to fix multi-line change files and reduce commit noise.

[0.7.0]

  • The bullet point commit messages were occasionally returning undefined. Remove the ternary and more cleanly checking the logic.
    • 527d7e3 remove ternary and explicitly consider changelog commit bullet points (#260) on 2023-01-13
  • Update multiple devDeps, semver, yargs, inquirer, and packages in our action. This is primarily internal upgrades and don't affect external APIs.
  • Remove the to-vfile package as a dependency. This allows us to focus our file reference to our specific needs, and one less dependency to maintain. With this change, we also converted a handful of promises into generators for better compatibility and control with effection.
  • Upgrade to effection v2. This is primarily an internal improvement, but will enable future features such as fetching from an endpoint to check if a version of a package was published. It also brings an updated dependency to gracefully shutdown windows processes.

[0.6.1]

  • Include a copy of the license in each package.
    • Bumped due to a bump in all.
    • fa5c061 chore: add license files to packages (#225) on 2021-09-24

[0.6.0]

  • Extract out types into separate package to remove issues with circular dependencies.
    • 519da36 chore: set paths / references for TS and add types package (#213) on 2021-06-26

[0.5.0]

  • This switches to using Typescript project references to build (previously rollup). It should affect the underlying packages or use.
    • a9aedb1 chore: build workflow updates (#175) on 2021-04-07
    • 5506b19 feat: add preview command to covector (#187) on 2021-05-05
    • e388cc7 feat: prerelease mode and publishing (#180) on 2021-05-13
  • Add support for yaml based package files. Add support for generic file whose only content is a version number.
    • e8c98f5 feat: yaml and generic file support (#196) on 2021-05-07

[0.4.0]

  • Pull the most recent changelog into the chain of output. This opens up piping it into the Github Release.
    • 66539a8 fix: GitHub release pipe (#164) on 2021-03-24

[0.3.0]

  • Convert covector to typescript.
    • cf9a893 feat: typescript covector main with rollup (#63) on 2020-07-02
    • 39acdc9 feat: convert over @covector/files to typescript with rollup [partial] (#65) on 2020-07-06
    • 1090afd feat: typescript going green (#153) on 2021-03-17

[0.2.2]

  • Add a validation guardrail within the status command. This will run a nearly identical version application function. It can catch an error during the PR process rather than during the versioning process.
    • Bumped due to a bump in @covector/files.
    • 4437766 feat: version bump guardrail (#137) on 2021-02-10

[0.2.1]

  • Find all numbers in a PR no matter the quantity.
    • 4a39f15 fix: find changelog PR numbers of any size (#89) on 2020-07-10

[0.2.0]

  • Pipe git info into changelog using sub-bullet points for each commit it was involved in.
    • cc19486 feat: new command package and piped git info (#78) on 2020-07-09
    • de3248d feat: dep bump note in changelog (#87) on 2020-07-10
  • Note in sub-bullets when a bump was due to a dependency (and that helps note where there summary text is from as well.)
    • de3248d feat: dep bump note in changelog (#87) on 2020-07-10
  • Allow complex commands specified as an object. This let's one specify a dryRunCommand that is executed in --dry-run mode instead (so no accidental publishes!) or to set pipe to true that the output is returned from the main covector function. The pipe likely won't be used directly, but can be consumed within the action to create a Github Release, etc.
    • Bumped due to a bump in covector.
    • 3ca050c feat: advanced commands (#71) on 2020-07-06

[0.1.0]

  • Add option to execute commands in "--dry-run" mode which will output the anticipated commands without running them and additional relevant information (such as the command pipe).
  • Skip over packages without a path. This let's us create "virtual packages" and configure a package such as "all" that let's us easily bump everything.

[0.0.3]

Bumped due to dependency.

[0.0.2]

  • We missed files in the changelog deps array so they diverged when bumped.