diff --git a/versioning.md b/versioning.md index 1e98b50..ec6b637 100644 --- a/versioning.md +++ b/versioning.md @@ -64,3 +64,23 @@ bash resources/scripts/release-notes.bash ``` As we don't want to rely 100% on the script output and want to have the possibility to add some manual notes, we will add the release notes to the `CHANGELOG.md` file. + +To have the script ad hand whenever you need it, you can add the folder where it is located to your `PATH` environment variable. This is an example of the Ansible snipped for macOS based systems assuming you have git cloned this repository to your home directory under `Development` subfolder: + +```yaml +- name: Add release-notes script to path + lineinfile: + path: "/Users/{{ macos_user }}/.zshrc" + line: 'export PATH=$PATH:/Users/{{ macos_user }}/Development/docs-onboarding/resources/scripts' + state: present +``` + +And this would be the equivalent for Windows: + +```yaml +- name: Add release-notes script to path + win_path: + elements: + - C:\Users\{{ windows_user }}\Development\docs-onboarding\resources\scripts + state: present +```