Skip to content

Commit 1003c3c

Browse files
committed
Update instructions to use YYYY.WW.REV for release versions.
1 parent e339679 commit 1003c3c

File tree

2 files changed

+11
-20
lines changed

2 files changed

+11
-20
lines changed

README.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -89,27 +89,18 @@ There are two stages, testing and deployment.
8989

9090
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.
9191

92-
- 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`
93-
- 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`
94-
95-
- Here is a command line script to generate the local identifier, tested on Mac:
96-
97-
```
98-
TAG_NAME=$(date +%Y-%m-%d)-A && \
99-
SHA=$(git rev-parse HEAD) && \
100-
git tag -a "$TAG_NAME" "$SHA" -m "Release $TAG_NAME" && \
101-
git push origin "$TAG_NAME"
102-
```
103-
104-
- The new version will be `{NEXT_SEMVER}+{LOCAL_VERSION}`, e.g. `1.1.4+2024-08-24-A`
105-
- **Update `setup.py` with this version.**
106-
- Create a tag at the SHA from the testing phase, using the local version identifier.
107-
108-
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)
92+
- 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`.
93+
- Get the current year and week with `date +%Y.%W`. Increment or roll over the version number as necessary.
94+
- **Update `setup.py` with this version.**
95+
- Create a local version identifier, with the format `YYYY-WW-REV`.
96+
- Create a tag at the SHA from the testing phase, using the local version identifier.
97+
<!-- TODO: Create a script using Python setuptools, `import pkg_resources; version = pkg_resources.require("MyProject")[0].version` and auto-increment/roll over versions.>
98+
99+
1. **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)
109100
- NOTE: Remove the SHA from [.doc_gen/validation.yaml](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/.doc_gen/validation.yaml)
110101
- This is easily accomplished in the UI.
111-
3. **Create a release**: Use the automated ["Create release from tag" button](https://github.com/awsdocs/aws-doc-sdk-examples-tools/releases/new) to create a new release with the new tag.
112-
4. **Perform internal update process**.
102+
2. **Create a release**: Use the automated ["Create release from tag" button](https://github.com/awsdocs/aws-doc-sdk-examples-tools/releases/new) to create a new release with the new tag.
103+
3. **Perform internal update process**.
113104
114105
## Security
115106

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setup(
77
name="aws_doc_sdk_examples_tools",
8-
version="1.0.4+2024-09-20-A",
8+
version="2024.40.0",
99
packages=["aws_doc_sdk_examples_tools"],
1010
package_data={"aws_doc_sdk_examples_tools": ["config/*.yaml"]},
1111
entry_points={

0 commit comments

Comments
 (0)