Skip to content

Commit 10fa6ad

Browse files
authored
Update README.md (#112)
1 parent 5218896 commit 10fa6ad

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -78,24 +78,27 @@ There are two stages, testing and deployment.
7878

7979
### 1. Testing
8080

81-
1. **Create a testing branch** from [aws-doc-sdk-examples@main](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main).
82-
2. **Find the most recent commit SHA in [aws-doc-sdk-examples-tools/commits/main](https://github.com/awsdocs/aws-doc-sdk-examples-tools/commits/main/)**.
83-
3. **Update your testing branch**: With your commit SHA (format: `org/repo@hash`, e.g. `awsdocs/aws-doc-sdk-examples-tools@e7c283e916e8efc9113277e2f38c8fa855a79d0a`), update the following files:
81+
1. **Merge your changes into** [aws-doc-sdk-examples-tools/commits/main](https://github.com/awsdocs/aws-doc-sdk-examples-tools/commits/main).
82+
2. **Create a testing branch** from [aws-doc-sdk-examples@main](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main).
83+
3. **Find the commit SHA that matches the latest change from [aws-doc-sdk-examples-tools/commits/main](https://github.com/awsdocs/aws-doc-sdk-examples-tools/commits/main)**.
84+
4. **Update the following files in your testing branch** with the commit SHA (format: `org/repo@hash`, e.g. `awsdocs/aws-doc-sdk-examples-tools@e7c283e916e8efc9113277e2f38c8fa855a79d0a`):
8485
- In [.github/workflows/validate-doc-metadata.yml](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/.github/workflows/validate-doc-metadata.yml), replace the current tag with the SHA.
8586
- Add only the commit SHA to the `allow_list` field in [.doc_gen/validation.yaml](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/.doc_gen/validation.yaml).
86-
4. **Open a Draft PR to main branch**: Do not publish for review. Wait for checks/tests to pass on the PR.
87+
5. **Open a Draft PR to main branch**: Do not publish for review. Wait for checks/tests to pass on the PR.
8788

8889
### 2. Deployment
89-
90-
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.
91-
- Run `stamp.sh` to determine the next version and update `setup.py`. Use `--release` to additionally create a tag and push to main.
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-
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)
94-
- NOTE: Remove the SHA from [.doc_gen/validation.yaml](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/.doc_gen/validation.yaml)
95-
- This is easily accomplished in the Github UI.
90+
1. **Run `stamp.sh --release` from the `main` branch to automatically perform the following actions**:
91+
- Update the `setup.py` version.
92+
- Create a tag in the -tools repository at the same SHA you identified earlier.
93+
- stamp.sh will create 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`.
94+
- Push the new tag to `main`
95+
1. **Update your testing PR branch**
96+
- 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)
97+
- Remove the SHA from [.doc_gen/validation.yaml](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/.doc_gen/validation.yaml)
98+
- This is easily accomplished in the Github UI.
9699
1. **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.
97100
1. **Perform internal update process**.
98-
- See `update.sh` script in internal package.
101+
- See `update.sh` script in internal package.
99102

100103
## Security
101104

0 commit comments

Comments
 (0)