Skip to content

Latest commit

 

History

History
113 lines (100 loc) · 6.41 KB

README.md

File metadata and controls

113 lines (100 loc) · 6.41 KB
Raw

Release process

The process of building a new release and publishing to Maven Central is currently a partly manual process.

Each project has a Release GitHub workflow that will push a release tag to the repo. The pushing of the release tag will trigger a build, which will build and upload artifacts and create a GitHub release.

What is not currently automated is the updating of Creek's internal dependencies, e.g. once creek-base is released, updating other projects that depend on it to the new release version. This needs to be done manually. PRs to switch to release dependencies prior to release, and to the new snapshot after release, should be tagged with the chore label, so that they do not show up in the release notes.

Release steps

  1. Check SonaType Lift and review:
    1. issues: resolving / suppressing as required.
    2. Dependency security vulnerabilities: Update transient dependencies where fixes exist. Clear out older transient dependency bumps where no longer needed.
  2. Check Maven Deps for similar to above.
  3. Run Dependabot on all repos to check for updates to dependencies. This helps ensures all components use a consistent set of 3rd-party libraries.
  4. Ensure all Dependabot related PRs are building successfully and then merge. Dependabot PRs will be tagged with the dependencies label.
  5. For non-patch releases, set the next release version on all repos to be released, using the Set Next Version workflow on GitHub.
  6. For each Creek repo, in the following order: 
                               creek-test
                               |
                           creek-base
                               |
                    ---------------------------------
                    |                               |
            creek-observability              creek-json-schema
                    |                                |
              creek-platform            creek-json-schema-gradle-plugin
                    |                   
               creek-service           
                    |
            creek-system-test
                    |
                    --------------------------------------
                    |                                    |
        creek-kafka & all extensions      creek-system-test-gradle-plugin
  7. ...follow these steps to release:
    1. Run GitHub dependency bot, e.g. the creek-base dependency bot
      This will generate a PR to update the version of other Creek components the repo depends on to the release build.
      1. Ignore any other non-Creek dependency update PRs for now. Merging them could result in inconsistent 3rd party library versions across the components.
      2. Label the Creek dependency PR with chore so that it is excluded from the release notes.
      3. Ensure the PR builds and then merge.
      4. Wait for the triggered Build on the main branch to complete.
    2. Run the Release workflow on GitHub e.g. Creek test Release.
    3. Ensure the Release workflow, and the triggered Build workflow on the release tag, complete successfully.
    4. Ensure artefacts are correctly published to the OSSHR Nexus, and later available on Maven Central.
    5. Ensure Gradle plugins are published to the Gradle Plugin Portal, e.g. org.creekservice.schema.json

Post release steps

Once all components are released, follow these post release steps:

  1. For creek-test, commit a small change, e.g. a newline in a doc. This will trigger a new snapshot build to be created. Once build...
  2. For each Creek repo, in the same order as above, namely 
                                creek-test
                                |
                            creek-base
                                |
                     ---------------------------------
                     |                               |
             creek-observability              creek-json-schema
                     |                                |
               creek-platform            creek-json-schema-gradle-plugin
                     |                   
                creek-service           
                     |
             creek-system-test
                     |
                     --------------------------------------
                     |                                    |
         creek-kafka & all extensions      creek-system-test-gradle-plugin
                     |                                    |
                     --------------------------------------
                                        |
                            multi & single-module-template
  3. ...follow these steps to update to the next snapshot:
    1. Manually change the version to the new snapshot (Dependabot is broken for snapshot releases :'( ).
    2. Label the PR with chore so that it is excluded from the release notes.
    3. Merge this PR once its green.
  4. Announce on main doc site https://github.com/creek-service/creek-service.github.io e.g. creek-service/creek-service.github.io#11
    1. Create a post announcing the new release.
    2. Update _pages/home.md to reference new release version and announcement post.

Notes on release process

The Creek organisation in GitHub has secrets containing:

Developer setup

Nothing is required on a local developers machine.

However, creating a GPG key and adding it to ~/.gradle/gradle.properties will mean locally created artifacts are signed before publishing, e.g. to mavenLocal(). This can be usual for testing the build scripts.