julia-actions/cache
1
0
Fork 0
mirror of https://github.com/julia-actions/cache.git synced 2026-02-12 09:26:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Make release instructions more copy/paste-able

Browse Source
This commit is contained in:
Curtis Vogt
2024-06-27 09:47:19 -05:00
parent 580d2b69d8
commit 9b47d1cdb0
1 changed files with 23 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
devdocs/making_a_new_release.md
View File

@@ -4,53 +4,52 @@ In this guide, as an example, `v2.2.0` refers to the version number of the new r
## Part 1: Use the Git CLI to create and push the Git tags ## Part 1: Use the Git CLI to create and push the Git tags
Step 1: Create a new lightweight tag of the form `vMAJOR.MINOR.PATCH`. Step 1: Clone the repository:
```bash ```bash
git clone git@github.com:julia-actions/cache.git git clone git@github.com:julia-actions/cache.git
cd cache cd cache
git fetch --all --tags ```
git checkout main Step 2: Create a new lightweight tag of the form `vMAJOR.MINOR.PATCH`.
git --no-pager log -1 ```bash
# Take note of the commit hash here. # Get the commit SHA of the latest pushed commit on the default branch
git fetch origin --tags --force
commit_sha=$(git rev-parse origin/HEAD)
# Validate this commit is the one you intend to release
git --no-pager log -1 ${commit_sha:?}
# Now, create a new lightweight tag of the form `vMAJOR.MINOR.PATCH`. # Now, create a new lightweight tag of the form `vMAJOR.MINOR.PATCH`.
#
# Replace `commit_hash` with the commit hash that you obtained from the
# `git log -1` step.
#
# Replace `v2.2.0` with the actual version number that you want to use. # Replace `v2.2.0` with the actual version number that you want to use.
git tag v2.2.0 commit_hash tag=v2.2.0
git tag ${tag:?} ${commit_sha:?}
``` ```
Step 2: Once you've created the new release, you need to update the `v2` tag to point to the new release. For example, suppose that the previous release was `v2.1.0`, and suppose that you just created the new release `v2.2.0`. You need to update the `v2` tag so that it points to `v2.2.0`. Here are the commands: Step 3: Once you've created the new release, you need to update the major tag to point to the new release. For example, suppose that the previous release was `v2.1.0`, and suppose that you just created the new release `v2.2.0`. You need to update the major tag `v2` so that it points to `v2.2.0`. Here are the commands:
```bash ```bash
# Create/update the new v2 tag locally, where the new v2 tag will point to the # Create/update the new major tag locally, where the new major tag will point to the
# release that you created in the previous step. # release that you created in the previous step.
# #
# Make sure to change `v2.2.0` to the actual value for the tag that you just # The `-f` flag forcibly overwrites the old major tag (if it exists).
# created in the previous step. major_tag=$(echo ${tag:?} | grep -o '^v[0-9]*')
# git tag -f ${major_tag:?} ${tag:?}
# The `-f` flag forcibly overwrites the old
# `v2` tag (if it exists).
git tag -f v2 v2.2.0
``` ```
Step 3: Now you need to push the tags: Step 4: Now you need to push the tags:
```bash ```bash
# Regular-push the new `v2.2.0` tag: # Regular-push the new tag:
git push origin tag v2.2.0 git push origin tag ${tag:?}
# Force-push the new v2 tag: # Force-push the new major tag:
git push origin tag v2 --force git push origin tag ${major_tag:?} --force
``` ```
## Part 2: Create the GitHub Release ## Part 2: Create the GitHub Release
Go to the [Releases](https://github.com/julia-actions/cache/releases) section of this repo and create a new release (using the GitHub web interface). Go to the [Releases](https://github.com/julia-actions/cache/releases) section of this repo and create a new release (using the GitHub web interface).
For the "choose a tag" drop-down field, select the `v2.2.0` tag that you created and pushed in Part 1 of this guide. For the "choose a tag" drop-down field, select the new tag (e.g. `v2.2.0`) that you created and pushed in Part 1 of this guide.