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

docs: Update CHANGELOG.md through version 0.3.0 #63

Merged
merged 11 commits into from Oct 2, 2020
80 changes: 60 additions & 20 deletions CHANGELOG.md
@@ -1,41 +1,81 @@
## 0.3.0

- Node >=10.x now required.
- Added getElementsByClassName method.
- Added Node to the list of exports
- Added lowercase of åäö in entityMap.
- Moved existing sources into `lib` subdirectory.
- Removed `.npmignore` in favor of `files` entry in package.json.
- More `package.json` refactoring.
- Replaced CHANGELOG with more rigorous file.
- Replaced LICENSE with more rigorous file.
- Removed component.json (deprecated package manager https://github.com/componentjs/guide)
- `proof` devDep updated to latest.
- Fixed CI.
[Commits](https://github.com/xmldom/xmldom/compare/0.2.1...0.3.0)

- **BREAKING** Node >=10.x is now required.
- **BREAKING** Removed component.json (deprecated package manager https://github.com/componentjs/guide)
- **BREAKING** Moved existing sources into `lib` subdirectory.
- Update devDependency `proof`
karfau marked this conversation as resolved.
Show resolved Hide resolved
- Removed `.npmignore` in favor of `files` entry in `package.json`.
karfau marked this conversation as resolved.
Show resolved Hide resolved

karfau marked this conversation as resolved.
Show resolved Hide resolved
- [Added `Document.getElementsByClassName`](https://github.com/xmldom/xmldom/issues/24).
- [Added `Node` to the list of exports](https://github.com/xmldom/xmldom/pull/27)
- [Added lowercase of åäö in `entityMap`](https://github.com/xmldom/xmldom/pull/23).
- More `package.json` cleanup/refactoring.
- Moved CHANGELOG to markdown file.
- Moved LICENSE to markdown file.
- Fixed travis CI.
- README updates.

## 0.2.1

- More package.json refactoring.
[Commits](https://github.com/xmldom/xmldom/compare/0.2.0...0.2.1)

- Correct `homepage`, `repository` and `bugs` URLs in `package.json`.

## 0.2.0

- Now publishing under xmldom npm package again; retiring xmldom-alpha.
[Commits](https://github.com/xmldom/xmldom/compare/v0.1.27...0.2.0)

**Includes all BREAKING changes introduced in [`xmldom-alpha@v0.1.28`](#0128-only-via-xmldom-alpha-npm-package) and in later commits to master by the original authors.**

- **BREAKING?** [removes the `Object.create` check from the `_extends` method of `dom.js` that added a `__proto__` property](https://github.com/xmldom/xmldom/commit/0be2ae910a8a22c9ec2cac042e04de4c04317d2a#diff-7d1c5d97786fdf9af5446a241d0b6d56L19-L22) ().
- **BREAKING?** [removed code that added a `__proto__` property](https://github.com/xmldom/xmldom/commit/366159a76a181ce9a0d83f5dc48205686cfaf9cc)
karfau marked this conversation as resolved.
Show resolved Hide resolved

- formatting/corrections in `package.json`
- Remove coveralls.
- Disable cache in travis.
karfau marked this conversation as resolved.
Show resolved Hide resolved
- Other refactoring.

## 0.1.28 (via xmldom-alpha npm package)
## 0.1.31

[Commits](https://github.com/xmldom/xmldom/compare/v0.1.27...v0.1.31)

The patch versions (`v0.1.29` - `v0.1.31`) that have been released on the [v0.1.x branch](https://github.com/xmldom/xmldom/tree/0.1.x), to reflect the changed maintainers, **have been branched off from [`v0.1.27`](#0127-via-xmldom-and-xmldom-alpha-npm-package) so they don't include the breaking changes introduced in [`xmldom-alpha@v0.1.28`](#0128-only-via-xmldom-alpha-npm-package)**:

## Maintainer changes

After the last commit to the original repository <https://github.com/jindw/xmldom> was done on the 9th of May 2017, the first commit to this fork was done on the 19th of December 2019. [It has been announced in the original repository on the 2nd of March 2020.](https://github.com/jindw/xmldom/issues/259)

The versions listed below have been published to one or both of the following packages:
- <https://www.npmjs.com/package/xmldom-alpha>
- <https://www.npmjs.com/package/xmldom>

The new maintainers do not plan to continue publishing the `xmldom-alpha` package.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Not all existing maintainers are "new". Namely @kethinov came from the original xmldom project location. And previous maintainers are welcome to join together with us as well. More details are in issue #9.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So it could just say "The current maintainers ...", right?
Or we could simplify to "There are currently no plans to continue publishing ..."

Do you want to add a sentence about "old and new maintainers" to that section? Feel free to just do that.


The new maintainers did not invest time to understand changes that led to the last `xmldom` version `v0.1.27` published by the original maintainer, but consider it the basis for their work.
A time line of all the things that happened from that version until `0.3.0` is available in <https://github.com/xmldom/xmldom/issues/62> and related questions should be asked there.
karfau marked this conversation as resolved.
Show resolved Hide resolved

## 0.1.28 (only via xmldom-alpha npm package)

[Commits](https://github.com/xmldom/xmldom/compare/v0.1.27...xmldom-alpha@v0.1.28)

published by @jindw on the 9th of May 2017

- [`license` field in `package.json` was fixed](https://github.com/jindw/xmldom/pull/178)
- [Conditional converting of HTML entities](https://github.com/jindw/xmldom/pull/80)
- BREAKING [introduced regression regarding `&nbsp;`](https://github.com/xmldom/xmldom/issues/57)
- `dom.js` fixed serialization issue for missing document element ([example that failed on `toString()` before this change](https://github.com/xmldom/xmldom/blob/a58dcf7a265522e80ce520fe3be0cddb1b976f6f/test/parse/unclosedcomment.js#L10-L11))
- new module `entities.js`

- Removed __proto__ accessor.
- Appended HTML entities defaults.
## 0.1.27 (via xmldom and xmldom-alpha npm package)
karfau marked this conversation as resolved.
Show resolved Hide resolved

## 0.1.27 (via xmldom-alpha npm package)
published by @jindw on the 28th of Nov 2016

- Various bug fixes.
- Don't ask why 0.1.26 and 0.1.25 were skipped. `¯\_(ツ)_/¯`
- Don't ask why 0.1.26 and 0.1.25 were skipped here, but they have been released only to xmldom npm package on the same day as 0.1.27. `¯\_(ツ)_/¯`
karfau marked this conversation as resolved.
Show resolved Hide resolved

## 0.1.24 (via xmldom-alpha package)
## 0.1.24 (via xmldom and xmldom-alpha package)
karfau marked this conversation as resolved.
Show resolved Hide resolved

- Added node filter.

Expand Down