nih-cfde / use-case-library-build

https://use-cases.nih-cfde.org/
1 stars 1 forks source link

Release plan documentation, automation, website aesthetics #16

Closed s-canchi closed 3 years ago

s-canchi commented 3 years ago

Added Release plan documentation with information on tags and notes generation along with automation workflow to generate release notes. I also modified the website aesthetics to match the proposed training website look and updated site URLs when necessary.

Please place an 'x' between the brackets to indicate a yes answer to the questions below.

For previewing your changes:

For requesting final pull request to the master branch:

s-canchi commented 3 years ago

I can implement a further refinement in tracking of the release notes based on label system to differentiate PR type as well as category. If that is a requirement, please let me know the possible categories and types that might be used in this repo.

ACharbonneau commented 3 years ago

I can implement a further refinement in tracking of the release notes based on label system to differentiate PR type as well as category. If that is a requirement, please let me know the possible categories and types that might be used in this repo.

I don't know what this means, so I'm going to assume I don't need it :)

s-canchi commented 3 years ago

The way the action is currently setup, all PRs merging into latest will be added to the release notes and with every release, the version number bumps up one in Minor number. There is a possibility of adding labels to categorize what type of PR it is (for example new use case, fixes to existing one etc) along with PR labels for version number (including major, minor etc). That will help resolve any version number bumps automatically as well as streamline the notes by categorizing the type of changes. However, the implementation requires explicit use of labels with PRs. I wanted to let you know of this additional feature in case we would like to implement it. It can also be implemented at a later time if need be.

ACharbonneau commented 3 years ago

hmm. So, I like the idea of being able to automatically say 'new thing' vs 'finished thing', that is, use cases added vs me adding a checkmark to show completion. we could consider adding that