Skip to content

Commit

Permalink
create internal documentation for release process
Browse files Browse the repository at this point in the history
  • Loading branch information
antoniave committed Jan 5, 2024
1 parent 8da0d88 commit 586ee82
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Open Pioneer Core Packages

For general documentation hints see [Projekt README](../README.md).

## Table of contents

- Internal documentation
- [Release Process](./internals/Releasing.md)

36 changes: 36 additions & 0 deletions docs/internals/Releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Release Process

This document explains which steps need to be performed a release for the open pioneer trails core packages.

For a description of how to publish an open pioneer trials package in general, refer to https://github.com/open-pioneer/trails-starter/blob/main/docs/tutorials/HowToPublishAPackage.md.


## Background information

For the release of the open pioneer trails core packages,
pipelines have been implemented so that only a few manual steps (see below) are necessary to perform a release.

The release will be performed for all packages that contain changes or do have a dependency on a package that changed.

During the following things are automatically done:
- Write changelog files using changesets
- Build packages and publish to npm public registry
- Create GitHub Releases for the published packages

Currently, there is no process for publishing only single packages
(as packages usually depend on each other, there is no use case for publishing a single package).
If publishing a single package is actually needed, refer to the changeset documentation about
how to exclude other packages for a release.
However, this is quite complicated and should only be done sensible.

## Steps to perform a release:
- Check if all contents of main branch may be released (regarding content and technical aspects).
- Check that all packages contain CHANGELOG.md files and that changeset entries are created for all
changes, even completely new packages.
- Check all changeset entries regarding the version that will be release.
In particular, take care that no major release is done accidentally.
- Check that the build of the last commit performed successfully (is green)
and that the last commit is included in the [RELEASE] pull request created by changesets.
- Main step: Merge the [RELEASE] pull request.
- When all pipelines of the merged pull request are done, check that all published packages have been
uploaded to the npm public registry and GitHub release have been created for these packages.

0 comments on commit 586ee82

Please sign in to comment.