How do I use the bin/project* scripts?

[certa1n]

Hello. Possible a small instructions abou use your any scripts?

project-release-notes project-version-commit project-version-update git-tag-versions

Thank you!

[sunaku]

Sure, I use those project-* scripts to generate release notes for my md2man, binman, tork, and dasht projects. Let's take the latter as an example:

1. Clone dasht:

   git clone https://github.com/sunaku/dasht.git
   cd dasht/

2. Preview the release notes for the upcoming release:

   project-release-notes VERSION.md

3. Insert the new release notes at the top of the history file (VERSION.md in this case):

   vim VERSION.md
   :0r! project-release-notes %
   :wq

4. Update all mentions of the old release to the new release:

   project-version-update VERSION.md

5. Inspect the changes and stage them for committing if correct:

   git diff
   git add -u

6. Commit the new release:

   project-version-commit VERSION.md

7. You can now publish the new release whenever you're ready:

   git push && git push --tags

[certa1n]

Thank you!

[sunaku]

Note that I renamed all of these scripts to floss-* in commit fa687eff22857a5ba1de0d44a19bfe878a4a4487, as follows:

• floss-rebase: Reapplies the stacked branch architecture: master => other => patch => minor => major

• floss-merge: Merges all branches up to and including current branch into master branch.

• floss-changes: Prints release notes ranging from the current branch to the master branch.

• floss-reflect: Updates all text files in the project that mention the current version and/or date to match the first version and date from the HISTORY_FILE.

• floss-commit: Creates a new commit or updates an existing commit that is labelled with the first version and date from the HISTORY_FILE.

• floss-publish: Publishes manuals to the GitHub pages website after a project release.