Release environments for deployments

• State: Draft
• Created: 2021-07-25
• Tags: deployment

Context

We should add an environment variable that allows us to know the release version, either using git commit, version, or whatever we decide TBD, we use this to track the releases of the app, and be able to use that in tracing, logging, error reporters and so on

Resolution

• TBD

Links

• https://docs.sentry.io/product/releases/

Michael Nygard for all his work on Architecture Decision Records: https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions

[short title of solved problem and solution]

• State:
• Replaced by:
• Deciders:
• Created:

Context and Problem Statement

Decision Drivers

Considered Options

Option [1]

[example | description | pointer to more information | …]

• Good, because [argument a]
• Good, because [argument b]
• Bad, because [argument c]
• … numbers of consequences

Decision Outcome

Chosen option: "[option 1]", because [justification. e.g., only option, which
meets k.o. criterion decision driver | which resolves force force | … | comes
out best (see below)].

Advantages

• [e.g., improvement of quality attribute satisfaction, follow-up decisions
  required, …]
• …

Disadvantages

• [e.g., compromising quality attribute, follow-up decisions required, …]
• …

Links

Secrets Token Format

• State: Draft
• Tags: secrets

Context

Be able to scan code and search for secrets statically

Resolution

Links

• https://github.blog/changelog/2021-03-31-authentication-token-format-updates-are-generally-available/
• https://docs.github.com/en/developers/overview/secret-scanning-partner-program
• https://docs.github.com/en/code-security/secret-scanning/secret-scanning-partners
• https://docs.github.com/en/code-security/secret-scanning/about-secret-scanning
• https://www.digitalocean.com/blog/updated-api-tokens-new-management-features

Context

How should we come up with some tagging for an app that allows us to use it in places like Sentry, HTTP calls headers, or any other thing that would be important to know which version of the app actually caused the issue, maybe even give customer support teams more insights and have fullstory metadata optimized as well.

Resolution

I am not sure, we should learn from others' good practices, here are some ideas so far of potential information.

• AppName: identity of the app, for example: my-website
• Release: identity of the release of the app, for example: d6cd1e2bd19e03a81132a23b2025920577f84e37 (commit sha) or v2.4.3
• Environment: the environment of the app, for example: environment potentially related to #21

Example:

• https://www.thoughtworks.com/radar/techniques/lightweight-architecture-decision-records
• https://radar.cncf.io/overview

React Component Properties API

• State: Draft
• Created:
• Tags:

Context

Talk about React Components API:

• The props should always be named in a way that they always either A) Are states or B) are callbacks;
• Avoid imperative properties such as setSomething or filterSomething and rather use onSetSomething or onFilterSomething

Resolution

[short title of solved problem and solution]

• State: Draft
• Created:
• Tags:

Context

Improve CHANGELOG.md maintains

Resolution

• You MUST include the following at the top of the CHANGELOG.md file

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

Links

Metadata

• Actor (ID, TYPE) of the event. Either a user or system.

Related links

• ylorph/The-Inevitable-Event-Centric-Book#42

Use .localhost for TLD in local developmen

• State: Draft
• Created:
• Tags:

Context

Bikeshedding about TLD for local development

Resolution

• You MUST use .localhost for local development DNS resolution

Links

• https://www.rfc-editor.org/rfc/rfc2606#section-2
• https://www.pluralsight.com/blog/software-development/choose-internal-top-level-domain-name

Add environments to all applications

• State: Draft
• Created: 2021-07-25
• Tags: app, releases

Context

We don't have misalignment configuring environments across applications, this is one of those that we don't need that much freedom, and nowadays most people end up doing the exact same thing

• development (preview, local dev, branch)
• staging (trunk branch, customer environment)
• production (official release)

Resolution

• You MUST add [PREFIX]_ENVIRONMENT to all your application deployments
• [PREFIX]_ENVIRONMENT MUST be one of the following values
  • development: when the release is based on a branch deployment, aka. preview deployment
  • staging: trunk branch, deployment before cutting a production release
  • production: the production version of the release

Links

• https://en.wikipedia.org/wiki/Deployment_environment
• https://docs.sentry.io/product/sentry-basics/environments/