Update instructions to use YYYY.WW.REV for release versions. #100
+69
−20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DavidSouther
added
Enhancement
DavidSouther
force-pushed
the
docs/release/date_based_semver
branch
from
a7d03e0
to
04fd29f
Compare
DavidSouther
force-pushed
the
docs/release/date_based_semver
branch
from
72b2fa5
to
76cfcb9
Compare
Laren-AWS
requested changes
Oct 1, 2024
| @@ -89,27 +89,14 @@ 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` | |||
| - 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`. | |||
There was a problem hiding this comment.
This description is rather opaque and the linked articles are long, but I see that it boils down to "run stamp.sh, probably with --release".
But maybe a crisper synopsis would help. Even just the comments in stamp.sh about how the tag is formed are probably enough.
|
|
||
| # And check that the REMOTE points to the -tools repo. | ||
| REMOTE="${REMOTE:origin}" | ||
| if [ "$(git remote get-url $REMOTE 2>/dev/null)" != "[email protected]:awsdocs/aws-doc-sdk-examples-tools.git" ] ; then |
There was a problem hiding this comment.
This fails for me because when I run this manually I get
$ git remote get-url origin
https://github.com/awsdocs/aws-doc-sdk-examples-tools.git
| NEXT=$(date +%Y.%W.0) | ||
| VERSION=$(compare_versions "$CURRENT" "$NEXT") | ||
| echo "Releasing $VERSION..." | ||
| sed -i '' "/version=/ s/$CURRENT/$VERSION/" setup.py |
There was a problem hiding this comment.
The extra '' after sed -i makes this fail.
| BRANCH=$(git rev-parse --abbrev-rev HEAD) | ||
| if [ "$BRANCH" != "main" ] ; then | ||
| echo "Not on main, exiting!" | ||
| # exit 1 |
There was a problem hiding this comment.
You'll want to uncomment these.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available: Closes #98
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.