From 1003c3c09fd39148193ccd98e72c143b8c6b7c2e Mon Sep 17 00:00:00 2001 From: David Souther Date: Tue, 1 Oct 2024 10:42:31 +0200 Subject: [PATCH 1/5] Update instructions to use YYYY.WW.REV for release versions. --- README.md | 29 ++++++++++------------------- setup.py | 2 +- 2 files changed, 11 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 5ab9843..26d3547 100644 --- a/README.md +++ b/README.md @@ -89,27 +89,18 @@ There are two stages, testing and deployment. 1. **Update the -tools version**: Once the tests pass, update the `setup.py` version and create a tag in the -tools repository at the same SHA you identified earlier. - - Determine the next [semver](https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers) number as appropriate for the changes in this release. e.g. `1.1.4` - - Create a local version identifier, with the format `YYYY-MM-DD-A`, where `YYYY-MM-DD` represents release date, and `-A` is used for the first release of the day (followed by `-B`, `-C`, etc., for subsequent same-day releases). e.g. `2024-08-24-A` - - - Here is a command line script to generate the local identifier, tested on Mac: - - ``` - TAG_NAME=$(date +%Y-%m-%d)-A && \ - SHA=$(git rev-parse HEAD) && \ - git tag -a "$TAG_NAME" "$SHA" -m "Release $TAG_NAME" && \ - git push origin "$TAG_NAME" - ``` - - - The new version will be `{NEXT_SEMVER}+{LOCAL_VERSION}`, e.g. `1.1.4+2024-08-24-A` - - **Update `setup.py` with this version.** - - Create a tag at the SHA from the testing phase, using the local version identifier. - -2. **Update your testing PR branch**: Remove SHA and add tag to [validate-doc-metadata.yml](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/.github/workflows/validate-doc-metadata.yml) + - Determine the next [stamp](https://blog.aspect.build/versioning-releases-from-a-monorepo) (which is valid [semver](https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers)) number as appropriate for the changes in this release. e.g. `2024.40.2`. + - Get the current year and week with `date +%Y.%W`. Increment or roll over the version number as necessary. + - **Update `setup.py` with this version.** + - Create a local version identifier, with the format `YYYY-WW-REV`. + - Create a tag at the SHA from the testing phase, using the local version identifier. +