Skip to content

Commit e89a0ed

Browse files
author
Bruce Irschick
authored
[AD-1059] Add documentation for release procedure. (#478)
1 parent f8e8eb1 commit e89a0ed

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

GETTING_STARTED.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -335,3 +335,46 @@ as project secrets. See the workflow file [gradle.yml](https://github.com/aws/am
335335
below. Go to EC2 Dashboard → **Network & Security** Group in the left menu → **Security** Group.
336336

337337
![Security Policy for EC2 Instance](src/markdown/images/getting-started/security-policy-ec2-instance.png)
338+
339+
## Release Procedure
340+
341+
1. Create a task and PR to update the version.
342+
1. Optional: Update dependencies to latest. The version is updated in file `gradle.properties`.
343+
2. Smoke test to ensure the version is updated.
344+
1. Generated file includes new version
345+
2. Using a BI tool like DbVisualizer, connect and check the driver version matches.
346+
3. Ensure the PR is merged.
347+
2. Run a manual GitHub workflow action for `Amazon DocumentDB JDBC Driver`.
348+
1. Run workflow →
349+
1. **Use workflow from**, Branch: `develop`
350+
2. **Test without DocumentDB?**`1`
351+
3. **Prepare files to publish in maven repo?**`1`
352+
2. Following the link for the workflow,
353+
1. Download the `output` artifact.
354+
3. Create a new release
355+
1. On GitHub releases page for the project, click the **Draft a new release** button.
356+
2. Version number is `v<M.m.p>` (e.g., `v1.4.3`)
357+
3. The Release title should be `Amazon DocumentDB JDBC Driver v<M.m.p>` (e.g. `Amazon DocumentDB JDBC Driver v1.4.3`)
358+
4. For the **Previous tag**, choose the tag for the previous version from the drop-down list.
359+
5. Click the **Generate release notes** button.
360+
6. Add artifacts
361+
1. `documentdb-jdbc-<version>-all.jar` - This can be obtained from the output artifact using the manual workflow action above found inside subfolder jarfile.
362+
2. `documentdbjdbc-<version>.taco`
363+
1. **Note**: _Currently (2022-12-20), we are not signing the generated TACO file. So it is a copy of the previous version with the file name changed to the current version._
364+
7. Enable the **Set as the latest release** option.
365+
8. Click the **Publish release** button.
366+
4. Upload artifacts bundle to Maven
367+
1. Go to site: [Nexus Repository Manager](https://aws.oss.sonatype.org/#welcome)
368+
2. Log in use credentials
369+
1. account: `aws-docdb-jdbc`
370+
2. password: `<secret>`
371+
3. Click **Staging Upload**
372+
4. Set **Upload Mode** to `Artifact Bundle`
373+
5. Click the **Select Bundle to Upload**
374+
6. Select from the `output.zip` artifact downloaded from the manual workflow action, above from the path: `ouput/maven/bundle.jar`
375+
7. Click the **Upload Bundle**. Wait for upload to complete.
376+
8. Click the **Staging Repositories** link.
377+
1. Wait for the bundle to have A**ctivity** of **Last operation completed successfully**
378+
2. Check the **Content**.
379+
3. Ensure the bundle is selected. Then click the **Release** button.
380+

0 commit comments

Comments
 (0)