matrix-org / matrix-org/complement

Disambiguate blueprints by hash instead of name

Open
#273 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
99
Forks
72
Avg merge
4d 1h
Merged PRs (30d)
8

Description

This was one thing that tripped me up, while making a custom blueprint, initially the tests weren't properly working, I soon discovered this was because of the fact that blueprints are disambiguated by name.

It's a bit of a foot gun in my opinion, so I'm proposing that the implementation instead hashes these blueprint contents, and then generates them via their hashes, so that any duplicate deployment is deduplicated by their eventual instructions and contents, instead of the name.

I'm using "hash" loosely here, but "an identifier depending on the contents" would work as well.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by locating where blueprints are currently disambiguated by name and how custom blueprints are generated and tested. Done means the project has an agreed content-based identifier strategy and duplicate deployments are deduplicated by their resulting instructions and contents.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.