Skip to content

Commit

Permalink
docs: update tagging format
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian leggett committed Mar 28, 2024
1 parent ca4a0b4 commit 5418d4d
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/deployment/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,32 @@ order: 7
---

## Notify the team
1. Post a message into di-dev channel in the Data Infrastructure (DDaT) Team saying that you want to do a release and ask if there are any objections. If no objections, proceed with the following steps.

1. Post a message into di-dev channel in the Data Infrastructure (DDaT) Team saying that you want to do a release and ask if there are any objections. If no objections, proceed with the following steps.

## Tag your release

1. View the current [tags in Data Workspace](https://github.com/uktrade/data-workspace-frontend/tags)

- Make a note of the latest tag
- Check out the master branch and pull the latest.
- Create a new tag from the master branch following this format `v<year>-<month>-<day>` eg. v2024-01-19
- Create a new tag from the master branch(see "How to Tag your release")
- Push the new tag to Github

## How to Tag your release

**Format** `v<year>.<month>.<day>`

If there are multiple releases in one day, increment the tag alphabetically starting with `b`. For example `v2024.01.19` then `v2024.01.19.b`, `v2024.01.19.c` and so on.

**Example of how to tag and push**

```shell
git tag -a v2024-01-19 -m v2024-01-19
git tag -a v2024.01.19 -m v2024.01.19
```

```shell
git push origin v2024-01-19
git push origin v2024.01.19
```

## Create draft release notes
Expand All @@ -40,7 +46,6 @@ git push origin v2024-01-19
- Check the option "Set as the latest release"
- Click "Save draft"


## Release tag to production

1. Visit the [build job](https://jenkins.ci.uktrade.digital/view/Data/job/data-workspace/) in Jenkins
Expand Down

0 comments on commit 5418d4d

Please sign in to comment.