Skip to content

package rename changelog validation #157

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.

Sign up for GitHub

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

Merged
kanthesha merged 17 commits into from
Oct 17, 2023
Merged

package rename changelog validation #157

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
a64929d
allows changelog to maintain the history when package has been renamed
kanthesha Oct 6, 2023
9d93abb
Update src/changelog.ts
kanthesha Oct 9, 2023
96cb711
Update src/changelog.ts
kanthesha Oct 9, 2023
2ba442d
validation test added for renamed package changelog
kanthesha Oct 9, 2023
daf65a5
Update src/changelog-config.ts
kanthesha Oct 10, 2023
694ac81
Update src/changelog-config.ts
kanthesha Oct 10, 2023
6a43fba
command line params for version and tag prefix of the package before …
kanthesha Oct 12, 2023
0dbe4fc
refactor unreleasedLinkReferenceDefinition
kanthesha Oct 12, 2023
dc83e68
refactor released link reference definition
kanthesha Oct 12, 2023
b51a4fa
Apply JSDoc syntax for optional params
MajorLift Oct 12, 2023
dee072d
rename versionBeforePkgRename and tagPrefixBeforePkgRename and releas…
kanthesha Oct 13, 2023
bac92c7
Revert "Apply JSDoc syntax for optional params
MajorLift Oct 16, 2023
920aec1
added PackageRename type with version and tagPrefix properties
kanthesha Oct 16, 2023
5b24367
parse changelog test
kanthesha Oct 16, 2023
b674e81
Merge branch 'main' into package-rename-validation
kanthesha Oct 17, 2023
c553d22
Update src/changelog.ts
kanthesha Oct 17, 2023
3c4c682
Update src/changelog.ts
kanthesha Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Revert "Apply JSDoc syntax for optional params 
"

This reverts commit b51a4fa.
  • Loading branch information
@MajorLift
MajorLift committed Oct 16, 2023
commit bac92c74004c1b21d83c2ed9ad03936a6d80de4c
20 changes: 10 additions & 10 deletions src/changelog.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@ function getTagUrl(repoUrl: string, tag: string) {
* @param repoUrl - The URL for the GitHub repository.
* @param tagPrefix - The prefix used in tags before the version number.
* @param releases - The releases to generate link definitions for.
* @param [versionBeforePackageRename] - A version string of the package before being renamed.
* @param versionBeforePackageRename - A version string of the package before being renamed.
* An optional, which is required only in case of package renamed.
* @param [tagPrefixBeforePackageRename] - A tag prefix string of the package before being renamed.
* @param tagPrefixBeforePackageRename - A tag prefix string of the package before being renamed.
* An optional, which is required only in case of package renamed.
* @returns The stringified release link definitions.
*/
Expand Down Expand Up @@ -204,8 +204,8 @@ function stringifyLinkReferenceDefinitions(
* @param repoUrl - The URL for the GitHub repository.
* @param tagPrefix - The prefix used in tags before the version number.
* @param releases - The releases to generate link definitions for.
* @param [versionBeforePackageRename] - A version string of the package before being renamed.
* @param [tagPrefixBeforePackageRename] - A tag prefix string of the package before being renamed.
* @param versionBeforePackageRename - A version string of the package before being renamed.
* @param tagPrefixBeforePackageRename - A tag prefix string of the package before being renamed.
* @returns A unreleased link reference definition string.
*/
function getUnreleasedLinkReferenceDefinition(
Expand Down Expand Up @@ -259,8 +259,8 @@ function getUnreleasedLinkReferenceDefinition(
* @param repoUrl - The URL for the GitHub repository.
* @param tagPrefix - The prefix used in tags before the version number.
* @param releases - The releases to generate link definitions for.
* @param [versionBeforePackageRename] - A version string of the package before being renamed.
* @param [tagPrefixBeforePackageRename] - A tag prefix string of the package before being renamed.
* @param versionBeforePackageRename - A version string of the package before being renamed.
* @param tagPrefixBeforePackageRename - A tag prefix string of the package before being renamed.
* @returns A list of release link reference definitions.
*/
function getReleaseLinkReferenceDefinitions(
Expand Down Expand Up @@ -373,11 +373,11 @@ export default class Changelog {
*
* @param options - Changelog options.
* @param options.repoUrl - The GitHub repository URL for the current project.
* @param [options.tagPrefix] - The prefix used in tags before the version number.
* @param [options.formatter] - A function that formats the changelog string.
* @param [options.versionBeforePackageRename] - A version string of the package before being renamed.
* @param options.tagPrefix - The prefix used in tags before the version number.
* @param options.formatter - A function that formats the changelog string.
* @param options.versionBeforePackageRename - A version string of the package before being renamed.
* An optional, which is required only in case of package renamed.
* @param [options.tagPrefixBeforePackageRename] - A tag prefix string of the package before being renamed.
* @param options.tagPrefixBeforePackageRename - A tag prefix string of the package before being renamed.
* An optional, which is required only in case of package renamed.
*/
constructor({
Expand Down
4 changes: 2 additions & 2 deletions src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,9 @@ type ValidateOptions = {
* @param options.tagPrefix - The prefix used in tags before the version number.
* @param options.fix - Whether to attempt to fix the changelog or not.
* @param options.formatter - A custom Markdown formatter to use.
* @param [options.versionBeforePackageRename] - A version of the package before being renamed.
* @param options.versionBeforePackageRename - A version of the package before being renamed.
* An optional, which is required only in case of package renamed.
* @param [options.tagPrefixBeforePackageRename] - A tag prefix of the package before being renamed.
* @param options.tagPrefixBeforePackageRename - A tag prefix of the package before being renamed.
* An optional, which is required only in case of package renamed.
*/
async function validate({
Expand Down
8 changes: 4 additions & 4 deletions src/parse-changelog.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ function isValidChangeCategory(category: string): category is ChangeCategory {
* @param options - Options.
* @param options.changelogContent - The changelog to parse.
* @param options.repoUrl - The GitHub repository URL for the current project.
* @param [options.tagPrefix] - The prefix used in tags before the version number.
* @param [options.formatter] - A custom Markdown formatter to use.
* @param [options.versionBeforePackageRename] - A version string of the package before being renamed.
* @param options.tagPrefix - The prefix used in tags before the version number.
* @param options.formatter - A custom Markdown formatter to use.
* @param options.versionBeforePackageRename - A version string of the package before being renamed.
* An optional, which is required only in case of package renamed.
* @param [options.tagPrefixBeforePackageRename] - A tag prefix string of the package before being renamed.
* @param options.tagPrefixBeforePackageRename - A tag prefix string of the package before being renamed.
* An optional, which is required only in case of package renamed.
* @returns A changelog instance that reflects the changelog text provided.
*/
Expand Down
8 changes: 4 additions & 4 deletions src/validate-changelog.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,11 @@ type ValidateChangelogOptions = {
* the midst of release preparation or not. If this is set, this command will
* also ensure the current version is represented in the changelog with a
* header, and that there are no unreleased changes present.
* @param [options.tagPrefix] - The prefix used in tags before the version number.
* @param [options.formatter] - A custom Markdown formatter to use.
* @param [options.versionBeforePackageRename] - A version string of the package before being renamed.
* @param options.tagPrefix - The prefix used in tags before the version number.
* @param options.formatter - A custom Markdown formatter to use.
* @param options.versionBeforePackageRename - A version string of the package before being renamed.
* An optional, which is required only in case of package renamed.
* @param [options.tagPrefixBeforePackageRename] - A tag prefix string of the package before being renamed.
* @param options.tagPrefixBeforePackageRename - A tag prefix string of the package before being renamed.
* An optional, which is required only in case of package renamed.
* @throws `InvalidChangelogError` - Will throw if the changelog is invalid
* @throws `MissingCurrentVersionError` - Will throw if `isReleaseCandidate` is
Expand Down