Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Example of a GovStack Building Block Definition Document:  govstack-bb-consent-management-definition

Example of a forked GovStack Building Block:gov.in-bb-consent-management-definition

Version schema

Building block definition documents have the following version 1.0.0 or X.Y.Z

...

A document can be versioned and released from a local source to clearly label draft status, experimental forks etc. For example if a WG member releases an artefact from their own Git branch, they may want to add the git commit hash or a timestamp, example: govstack-bb-consent-management-definition-1.2.3-git2be5010706654

...

  • Original GovStack version: govstack-bb-consent-management-definition-1.0.0

  • Forked version from gov.in, first release:bb-consent-management-definition-gov.in-1.0.0-0.1

...

Workflow

Google

Git

Comment

Definition doc draft

govstack-bb-consent-management-definition-gdocs-1.0.0-draft1

Here we can - if useful - tag versions in Google Doc with suffixes indicating a fortrunning draft number. So for instance, everytime a WG member signs off, they can cut out a version draft number.

Definition doc review

govstack-bb-consent-management-definition-gdocs-1.0.0

Finally, we release a “stable” document without the draft suffix.

Definition doc feedback processing

govstack-bb-consent-management-definition-gdocs-1.0.1

During a rapid processing of review feedback, we may wish to indicate updates by bumping the patch version each time, making the changes visible to review panellists.

Release Google Document to GitHub

govstack-bb-consent-management-definition-1.0.1

We continue the version number from Google Docs in order for backtracking to happen. But we remove“-gdocs” from the name.

Release for POC

This document will have SRS level detail with proven POC

Product level version

Same BB may be be used in different products, with different customization

Country level version

Same product may be used in different countries with different customization 

...