Skip to content

Commit

Permalink
Version bump
Browse files Browse the repository at this point in the history
Bump the version by changing the version number in the help text.

Also document the versioning strategy and release process in the
Contributing Guidelines.
  • Loading branch information
ericcornelissen committed Jul 28, 2023
1 parent 036bf3f commit 25c8922
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 11 deletions.
10 changes: 0 additions & 10 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
# Usage:
# Create a version tag ("v$YEAR.$MONTH") with an annotation containing the release notes and push
# the tag to GitHub. For example, use:
#
# git tag -a v23.07
# git push origin v23.07
#
# This workflow will create a GitHub Release for the version using the annotation as release text
# with several compiled version of the project attached.

name: Publish
on:
push:
Expand Down
50 changes: 50 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ this document.
- [Vetting](#vetting)
- [Auditing](#auditing)
- [License Compliance](#license-compliance)
- [Releasing](#releasing)
- [Release Numbering](#release-numbering)
- [Release Process](#release-process)
- [IDEs](#ides)
- [Visual Studio Code](#visual-studio-code)

Expand Down Expand Up @@ -448,6 +451,53 @@ The license compliance policy is stored in `deny.toml`.

---

## Releasing

### Release Numbering

Releases of this project are numbered based on the year and month in which they were released. Both
the year and month must always be represented with two digits, for example `23.01` for January 2023.

In the event a patch has to be released when a release already took place that month an incremental
integer suffix is added to the release number, for example `23.01-1` (i.e. `23.01 == 23.01-0`).

### Release Process

To create a new release, first update the release number in the CLI help text by changing the
following line, for example:

```diff
- /// Remove (unlink) the PATH(s) - v23.06
+ /// Remove (unlink) the PATH(s) - v23.07
```

Commit this change with a message along the lines of "Version bump", for example:

```shell
git commit -m "Version bump"
```

Get this commit onto the project's default branch. When it is, tag the commit with same value used
for the CLI help text. Give the tag an annotation with a list of changes since the last release, for
example:

```shell
git tag -a v23.07
```

Push the tag to the GitHub repository, for example:

```shell
git push origin v23.07
```

This will trigger the [`publish.yml` workflow] which will create a GitHub Release for the release
and compiled binaries for various platforms and architectures.

[`publish.yml` workflow]: ./.github/workflows/publish.yml

---

## IDEs

To get the most out of your code editor when contributing to this project you can use the tips
Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ mod cli {
#[cfg(test)]
use proptest_derive::Arbitrary;

/// Remove (unlink) the PATH(s) - v23.06
/// Remove (unlink) the PATH(s) - v23.07
///
/// Does not remove anything by default, use either the option --force or --interactive to
/// perform the removal.
Expand Down

0 comments on commit 25c8922

Please sign in to comment.