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

Script to generate changelog and release notes #830

Closed
snyaggarwal opened this issue Jul 7, 2021 · 3 comments
Closed

Script to generate changelog and release notes #830

snyaggarwal opened this issue Jul 7, 2021 · 3 comments
Assignees
Labels
api2 OCL API v2 fhir OCL FHIR web2 OCL WEB v2
Milestone

Comments

@snyaggarwal
Copy link
Contributor

No description provided.

@snyaggarwal snyaggarwal added api2 OCL API v2 fhir OCL FHIR web2 OCL WEB v2 labels Jul 7, 2021
@snyaggarwal snyaggarwal self-assigned this Jul 7, 2021
@snyaggarwal
Copy link
Contributor Author

snyaggarwal commented Jul 9, 2021

  1. The script is there in oclapi2 and oclweb2 both
  2. The same script can be used to get release notes or changelog
  3. By default system commits are ignored -- (pattern -- 'Increase maintenance version', 'updated packages', '\[skip ci\]')
  4. changelog.md is added in oclapi2 and oclweb2
  5. The script works with Python versions 2 and 3.
  6. There is any API as well to look at the changelog /changelog/
  7. Usages:
  • help:
> python release_notes.py help

Usage:
python release_notes.py <from_version> <to_version> <verbose>
  • Release Notes
> python release_notes.py 2.0.2 2.0.11

##### 2.0.11 - Fri Jul 9 03:49:04 2021 +0000
- [OpenConceptLab/ocl_issues#823](https://github.com/OpenConceptLab/ocl_issues/issues/823) | includeMappings/includeInverseMappings for a collection's concept will now use the collection's scope
- [OpenConceptLab/ocl_issues#829](https://github.com/OpenConceptLab/ocl_issues/issues/829) | users lists can be filtered by last login before/since
  • Changelog
> python release_notes.py 2.0.2 2.0.11 True

##### 2.0.11 - Fri Jul 9 03:49:04 2021 +0000
- Update README.md
- [OpenConceptLab/ocl_issues#823](https://github.com/OpenConceptLab/ocl_issues/issues/823) | includeMappings/includeInverseMappings for a collection's concept will now use the collection's scope
- Adding skip ci when increasing maintenance version
- [OpenConceptLab/ocl_issues#829](https://github.com/OpenConceptLab/ocl_issues/issues/829) | users lists can be filtered by last login before/since
- concept get | decoding concept id
- Fixing client config views for source/collections
- on org save adding creator/updater as member
- collection concept reference add to decode concept uri
- Fixing concept get for encoded strings
- bumped self to 2.0.6
- Fixing source/collection search
  • To update changelog.md
> python release_notes.py 2.0.2 2.0.11 True | cat - changelog.md > temp && mv temp changelog.md

@paynejd paynejd modified the milestones: Sprint 14, Sprint 15 Jul 13, 2021
snyaggarwal added a commit to OpenConceptLab/oclapi2 that referenced this issue Jul 17, 2021
@rkorytkowski
Copy link
Contributor

rkorytkowski commented Jul 20, 2021

Do you include multiple commits for the same issue in release notes? We should only include it once. Could we use issue title instead of commit message there? If too much work then I would use the first commit message.

@snyaggarwal
Copy link
Contributor Author

Ya, it would be some work to get the title of the issue using GitHub API. I can merge the commits and use the first one thats easier.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api2 OCL API v2 fhir OCL FHIR web2 OCL WEB v2
Projects
None yet
Development

No branches or pull requests

4 participants