Use "Common Changelog" format for Changelog

[danielfromearth]

Resolves #554.

Use Common Changelog.

For instance, this change:

• recategorizes entries into "Common Changelog" groups
• formats headings
• uses an imperative mood
• adds author tags to each entry

This PR also adds a few missing entries to older release sections.

---

📚 Documentation preview 📚: https://earthaccess--584.org.readthedocs.build/en/584/

[danielfromearth]

@jhkennedy, @mfisher87 — following up from a mention of this yesterday — any suggestions for linting of markdown in a CI pipeline?

[mfisher87]

I'm OK with bringing prettier back for formatting markdown (no strong feelings on whether we go back to using it for YAML. The new formatter we're using for YAML is more configurable). We may want to find a different mirror than the archived official pre-commit one. Several folks have already forked it (e.g. https://github.com/rbubley/mirrors-prettier) to remove the alpha/beta versions that were causing us problems.

I do feel it's important to use a formatter for accessibility. It would be nice to also add a linter, if it's compatible with our formatter, to catch only-human-fixable things like broken links, but maybe we could treat that as a separate issue.

[jhkennedy]

When we had looked into markdown linting before, we settled on this one as being the best option:
https://github.com/DavidAnson/markdownlint

[danielfromearth]

Thanks @chuckwondo for spotting these, and I will incorporate those changes! I'm actually still working through the changelog entry-by-entry, and I'm currently about half-way through.

Another note to address (maybe there will be more as I get to more recent entries): I don't see the following changes listed in the changelog. Perhaps another person can double-check whether they should be added...

I think they would go in the [0.5.3] - 2023-08-01 section:

• Update example in search_datasets #247
• Improved remote cluster performance #259
• Test CI #260
• Limit documentation deployment #261
• add try block to return useful error message for failed download #263
• add download from onprem how-to #265

[danielfromearth]

Also noting these, which may be missing:

For [0.6.0] - 2023-09-20:

• Fix test_dataset_search_returns_valid_results integration test #294

For [0.7.0] - 2023-10-31:

• Fix test_auth_environ_raises integration test #320

For [0.8.0] - 2023-11-29:

• Update dependabot to make one update PR per month #340
• Allow single file URL inputs for earthaccess.download #347

[chuckwondo]

Thanks @chuckwondo for spotting these, and I will incorporate those changes! I'm actually still working through the changelog entry-by-entry, and I'm currently about half-way through.

Another note to address (maybe there will be more as I get to more recent entries): I don't see the following changes listed in the changelog. Perhaps another person can double-check whether they should be added...

I think they would go in the [0.5.3] - 2023-08-01 section:

• Update example in search_datasets #247
• Improved remote cluster performance #259
• Test CI #260
• Limit documentation deployment #261
• add try block to return useful error message for failed download #263
• add download from onprem how-to #265

There may be a few of the above (and likely others not listed above) that can be removed from the changelog.

For example, there's likely no need to included these:

• Test CI #260
• Limit documentation deployment #261

These are likely classified as "noise," as they have no impact on users. See Remove noise. Please review existing entries, as well as entries you're considering adding, against the "noise" criteria to determine if existing ones can be removed, and whether or not missing entries should be added.

[danielfromearth]

pre-commit.ci autofix

[danielfromearth]

@chuckwondo, @mfisher87, I added a couple of the missing entries mentioned above, but left out the ones that seemed like they would be uninteresting to anyone other than the developers.

I think this is ready to merge! Was more work than I thought it would be to go through all the entries and cross-check them against the PR and issue lists on GitHub. I tried my best to capture who contributed to each PR/issue, and be as inclusive as possible, but if I missed someone, know that it wasn't intentional. Hopefully this is much better now, and gives credit to all the effort people have been doing to keep this awesome tool going and improving.

[mfisher87]

@danielfromearth AMAZING work!!! I appreciate that this is very hard and time consuming. Also worth it to show appreciation for everyone's work. I haven't had a chance to review this yet, but I'd like to make time for that in today's hack day and have a "merge party" :) Will you be there?

[danielfromearth]

Thanks @mfisher87 :)
We have some ESIP Openscapes preparation time scheduled at the same time as the first half of the hack day, but I should be there for the second half of the hack day.

[mfisher87]

Awesome. I want to spend some time on integration tests today too so I'll try and get that out of the way first ;)

[mfisher87]

Some discussion reflecting on the use of an "unreleased" section the way we do: vweevers/common-changelog#13

Change requests addressed