Update to release management #292
Pinned
markdumay
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
With the first major release of Hinode nearing, the release management process of Hinode is being streamlined. The next paragraphs capture the key elements of the revised approach. Where possible, these changes will be applied to the documentation and releases retrospectively.
Release notes
GitHub has the ability to automatically generate release notes. GitHub lists the merged Pull Requests (PRs) of a specific release and (optionally) groups them by label. It also gives credit to contributors and highlights first-time contributions.
To take full advantage of the generation of release notes, Hinode will focus on merging Pull Requests with a meaningful title from now on. So far, the codebase primarily used commit messages. Pull Requests would often refer to the branch name. Going forward, each PR will receive a label that is used to group them in the release notes. The PR title will summarize the change using active vocabulary.
The labels are used to put a PR in one of the following categories. The exact mapping of the labels to the categories is available in .github/release.yml.
Version tracking
Inspired by Bootstrap, Hinode will use buttons and alerts to introduce a new feature or revision in its documentation. The shortcode Release was introduced in
v0.14.1
to simplify the tracking of these changes in the documentation.Release overview
A timeline with key releases since the initial launch has been added to https://gethinode.com/releases/. The timeline captures releases with a significant change. The data is manually curated for now and is derived from the release notes available on GitHub.
Beta Was this translation helpful? Give feedback.
All reactions