Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.82 KB

RELEASE-INSTRUCTIONS.md

File metadata and controls

36 lines (22 loc) · 1.82 KB

Release Instructions

Follow the instructions below to trigger a release of the Technical Specifications.

To trigger a release, you need to have sufficient permissions on the wbcsd GitHub organization, as well as on this (wbcsd/data-exchange-protocol) repository and in the target repository wbcsd/tr.

You also need to have the GitHub CLI tool locally installed and be logged in to GitHub from your local terminal. See https://cli.github.com/ for further information.

1. Preparation

Make sure your specs/v2/index.bs file is ready. In particular, you should double check if:

  • The version number (Text Macro: VERSION <x.y.z>) contains a date (e.g. 2.2.1-20240521). This should only be used for the work in progress version of the Technical Specifications and should not be included in any release.
  • There is a changelog entry, indicating that a release is being made, and whether it is a consultation draft or a stable version.

2. Trigger the Release Workflow

On your command line, navigate to the data-exchange-protocol directory.

Use the following command to trigger the release:

sh release.sh <Consultation Draft|Release>

Make sure to replace <Consultation Draft|Release> by the actual option, i.e., either Consultation Draft or Release.

3. Open a PR in the wbcsd/tr Repository

On your browser, navigate to the wbcsd/tr repository.

At the top of the page, you shall see a yellow box and a green button to open a Pull Request.

Click the green button "Compare & pull request". On the new page, scroll down and click the green button "Create pull request."

4. Merge the PR

Once you are ready (e.g., someone else from the team has reviewed it), merge the PR by clicking the green "Merge pull request" button.