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

feat: automatically adding release notes from changelog #12

Merged
merged 11 commits into from
Nov 9, 2019

Conversation

michael-siek
Copy link
Member

@michael-siek michael-siek commented Oct 24, 2019

Used @stephenmathieson function to add changelog content to Github release for attest-ruby/java/node

Test results attest-java:
https://github.com/dequelabs/attest-java/blob/develop/CHANGELOG.md

Releasing v3.5.1
github-release.v0 release --user  --repo  --tag v3.5.1 --name Release 3.5.1 --description


### Bug Fixes

* IsAuditedForAccessibility should log by default ([#80](https://github.com/dequelabs/attest-java/issues/80)) ([9550f22](https://github.com/dequelabs/attest-java/commit/9550f22))

Test results attest-ruby:
https://github.com/dequelabs/attest-ruby/blob/develop/CHANGELOG.md

Releasing v2.4.0
github-release.v0 release --user  --repo  --tag v2.4.0 --name Release 2.4.0 --description

### Bug Fixes

- not use named capture groups in cucumber step regex ([#60](https://github.com/dequelabs/attest-ruby/issues/60)) ([58f4443](https://github.com/dequelabs/attest-ruby/commit/58f4443))
- Rspec examples test failures ([#47](https://github.com/dequelabs/attest-ruby/issues/47)) ([e0734f2](https://github.com/dequelabs/attest-ruby/commit/e0734f2))

### Features

- update to axe-matchers v2.4.1 ([53a6a2b](https://github.com/dequelabs/attest-ruby/commit/53a6a2b))

Test results attest-node-suite:
https://github.com/dequelabs/attest-node-suite/blob/develop/CHANGELOG.md

Releasing v2.8.1
github-release.v0 release --user  --repo  --tag v2.8.1 --name Release 2.8.1 --description


### Bug Fixes

* **aget:** Enable writing json uri mode ([#331](http://dequelabs/attest-node-suite/issues/331)) ([d3ffc6a](http://dequelabs/attest-node-suite/commits/d3ffc6a))
* **aget:** stub util test properly to allow for cross platform testing ([#280](http://dequelabs/attest-node-suite/issues/280)) ([8dd851b](http://dequelabs/attest-node-suite/commits/8dd851b))
* **aget:** Support Node v8 ([#264](http://dequelabs/attest-node-suite/issues/264)) ([da94013](http://dequelabs/attest-node-suite/commits/da94013))
* **attest-standards:** Allow from a dynamic list of tags ([#295](http://dequelabs/attest-node-suite/issues/295)) ([e885721](http://dequelabs/attest-node-suite/commits/e885721))

Closes issue: https://github.com/dequelabs/HTMLToolsTeamHub/issues/70

Reviewer checks

Required fields, to be filled out by PR reviewer(s)

  • Follows the commit message policy, appropriate for next version
  • Has documentation updated, a DU ticket, or requires no documentation change
  • Includes new tests, or was unnecessary
  • Code is reviewed for security by: << Name here >>

@michael-siek michael-siek changed the title Wip add release notes feat: automatically adding release notes from changelog Oct 29, 2019
@michael-siek michael-siek marked this pull request as ready for review October 29, 2019 13:53
@michael-siek michael-siek requested a review from a team October 29, 2019 13:53
Copy link
Member

@stephenmathieson stephenmathieson left a comment

Choose a reason for hiding this comment

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

Few small things.

.circleci/config.yml Outdated Show resolved Hide resolved
src/node-github-release.sh Outdated Show resolved Hide resolved
src/node-github-release.sh Outdated Show resolved Hide resolved
src/java-github-release.sh Show resolved Hide resolved
src/java-github-release.sh Outdated Show resolved Hide resolved
changelog=$"$changelog\n$line"
fi
fi
done <CHANGELOG.md
Copy link
Member

Choose a reason for hiding this comment

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

This errors if the file does not already exist. See #13

@stephenmathieson
Copy link
Member

The Java script has been tested/verified manually. See https://github.com/dequelabs/testing-repo/releases/tag/v3.5.1

Copy link
Member

@schne324 schne324 left a comment

Choose a reason for hiding this comment

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

Code LGTM... I have one comment (below) but I assume you've thought of this and I'm probably missing something so I am approving 😄

I have 0 experience working with/in this repo, plus I'm no shell script expert so I could be missing something but it seems we could extract the get_changelog() function into it's own file (say get_changelog.sh) and "import" it in each script via source get_changelog.sh.

NOTE: get_changelog.sh needs to be in one of the directories in $PATH; if it's not, you'll need to specify an absolute path

@stephenmathieson
Copy link
Member

seems we could extract the get_changelog() function into it's own file

Yep, that would be ideal, but it would be a breaking change, as we'd have to update all of our CI configurations to fetch that file as well. We figured a little copypasta here was better than updating all 12,000,062 repositories.

@michael-siek michael-siek merged commit 201f739 into develop Nov 9, 2019
@michael-siek michael-siek deleted the wip-add-release-notes branch November 9, 2019 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants