From abf08112d202d9144076b2f19117d240e3b34cec Mon Sep 17 00:00:00 2001 From: recanman <29310982+recanman@users.noreply.github.com> Date: Fri, 24 May 2024 19:34:46 -0700 Subject: [PATCH] docs: add publishing documentation --- PUBLISHING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 PUBLISHING.md diff --git a/PUBLISHING.md b/PUBLISHING.md new file mode 100644 index 0000000..a176f59 --- /dev/null +++ b/PUBLISHING.md @@ -0,0 +1,23 @@ +# Publishing a release + +This document describes the process of publishing a new version of the package. + +1. Update the version in the `composer.json` file. +2. Commit the changes. + - ```bash + git commit -m "chore(release): release v" + ``` + + Where `` is the new version number (e.g. `1.2.3`). +3. Create a new tag. + - ```bash + git tag v + ``` + + Where `` is the new version number (e.g. `1.2.3`). +4. Push the changes. + - ```bash + git push origin master --tags + ``` + +A release will automatically be created. \ No newline at end of file