-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
923 additions
and
139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,238 @@ | ||
| <!DOCTYPE HTML> | ||
| <html lang="en" class="light sidebar-visible" dir="ltr"> | ||
| <head> | ||
| <!-- Book generated using mdBook --> | ||
| <meta charset="UTF-8"> | ||
| <title>MD-23: Define Artifact Releases for Movement Technologies - MIP</title> | ||
|
|
||
|
|
||
| <!-- Custom HTML head --> | ||
|
|
||
| <meta name="description" content=""> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <meta name="theme-color" content="#ffffff"> | ||
|
|
||
| <link rel="icon" href="../../../../../favicon.svg"> | ||
| <link rel="shortcut icon" href="../../../../../favicon.png"> | ||
| <link rel="stylesheet" href="../../../../../css/variables.css"> | ||
| <link rel="stylesheet" href="../../../../../css/general.css"> | ||
| <link rel="stylesheet" href="../../../../../css/chrome.css"> | ||
| <link rel="stylesheet" href="../../../../../css/print.css" media="print"> | ||
|
|
||
| <!-- Fonts --> | ||
| <link rel="stylesheet" href="../../../../../FontAwesome/css/font-awesome.css"> | ||
| <link rel="stylesheet" href="../../../../../fonts/fonts.css"> | ||
|
|
||
| <!-- Highlight.js Stylesheets --> | ||
| <link rel="stylesheet" href="../../../../../highlight.css"> | ||
| <link rel="stylesheet" href="../../../../../tomorrow-night.css"> | ||
| <link rel="stylesheet" href="../../../../../ayu-highlight.css"> | ||
|
|
||
| <!-- Custom theme stylesheets --> | ||
|
|
||
| <!-- MathJax --> | ||
| <script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> | ||
|
|
||
| <!-- Provide site root to javascript --> | ||
| <script> | ||
| var path_to_root = "../../../../../"; | ||
| var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light"; | ||
| </script> | ||
| <!-- Start loading toc.js asap --> | ||
| <script src="../../../../../toc.js"></script> | ||
| </head> | ||
| <body> | ||
| <div id="body-container"> | ||
| <!-- Work around some values being stored in localStorage wrapped in quotes --> | ||
| <script> | ||
| try { | ||
| var theme = localStorage.getItem('mdbook-theme'); | ||
| var sidebar = localStorage.getItem('mdbook-sidebar'); | ||
|
|
||
| if (theme.startsWith('"') && theme.endsWith('"')) { | ||
| localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); | ||
| } | ||
|
|
||
| if (sidebar.startsWith('"') && sidebar.endsWith('"')) { | ||
| localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); | ||
| } | ||
| } catch (e) { } | ||
| </script> | ||
|
|
||
| <!-- Set the theme before any content is loaded, prevents flash --> | ||
| <script> | ||
| var theme; | ||
| try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } | ||
| if (theme === null || theme === undefined) { theme = default_theme; } | ||
| const html = document.documentElement; | ||
| html.classList.remove('light') | ||
| html.classList.add(theme); | ||
| html.classList.add("js"); | ||
| </script> | ||
|
|
||
| <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> | ||
|
|
||
| <!-- Hide / unhide sidebar before it is displayed --> | ||
| <script> | ||
| var sidebar = null; | ||
| var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); | ||
| if (document.body.clientWidth >= 1080) { | ||
| try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } | ||
| sidebar = sidebar || 'visible'; | ||
| } else { | ||
| sidebar = 'hidden'; | ||
| } | ||
| sidebar_toggle.checked = sidebar === 'visible'; | ||
| html.classList.remove('sidebar-visible'); | ||
| html.classList.add("sidebar-" + sidebar); | ||
| </script> | ||
|
|
||
| <nav id="sidebar" class="sidebar" aria-label="Table of contents"> | ||
| <!-- populated by js --> | ||
| <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox> | ||
| <noscript> | ||
| <iframe class="sidebar-iframe-outer" src="../../../../../toc.html"></iframe> | ||
| </noscript> | ||
| <div id="sidebar-resize-handle" class="sidebar-resize-handle"> | ||
| <div class="sidebar-resize-indicator"></div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <div id="page-wrapper" class="page-wrapper"> | ||
|
|
||
| <div class="page"> | ||
| <div id="menu-bar-hover-placeholder"></div> | ||
| <div id="menu-bar" class="menu-bar sticky"> | ||
| <div class="left-buttons"> | ||
| <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> | ||
| <i class="fa fa-bars"></i> | ||
| </label> | ||
| <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list"> | ||
| <i class="fa fa-paint-brush"></i> | ||
| </button> | ||
| <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu"> | ||
| <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li> | ||
| <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li> | ||
| <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li> | ||
| <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li> | ||
| <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li> | ||
| </ul> | ||
| <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar"> | ||
| <i class="fa fa-search"></i> | ||
| </button> | ||
| </div> | ||
|
|
||
| <h1 class="menu-title">MIP</h1> | ||
|
|
||
| <div class="right-buttons"> | ||
| <a href="../../../../../print.html" title="Print this book" aria-label="Print this book"> | ||
| <i id="print-button" class="fa fa-print"></i> | ||
| </a> | ||
| <a href="https://github.com/movementlabsxyz/MIP" title="Git repository" aria-label="Git repository"> | ||
| <i id="git-repository-button" class="fa fa-github"></i> | ||
| </a> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
| <div id="search-wrapper" class="hidden"> | ||
| <form id="searchbar-outer" class="searchbar-outer"> | ||
| <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> | ||
| </form> | ||
| <div id="searchresults-outer" class="searchresults-outer hidden"> | ||
| <div id="searchresults-header" class="searchresults-header"></div> | ||
| <ul id="searchresults"> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> | ||
| <script> | ||
| document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); | ||
| document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); | ||
| Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { | ||
| link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); | ||
| }); | ||
| </script> | ||
|
|
||
| <div id="content" class="content"> | ||
| <main> | ||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css"> | ||
| <h1 id="md-23-define-artifact-releases-for-movement-technologies"><a class="header" href="#md-23-define-artifact-releases-for-movement-technologies">MD-23: Define Artifact Releases for Movement Technologies</a></h1> | ||
| <ul> | ||
| <li><strong>Description</strong>: Define a process for releasing artifacts for Movement technologies.</li> | ||
| <li><strong>Authors</strong>: <a href="mailto:[email protected]">Liam Monninger</a></li> | ||
| </ul> | ||
| <h2 id="overview"><a class="header" href="#overview">Overview</a></h2> | ||
| <p>Provide a coherent and repeatable process for releasing artifacts for Movement technologies. This should be used for specifying the process of releasing artifacts for Movement technologies–particularly those that may require third-parties to adjust their usage of said technologies.</p> | ||
| <h2 id="definitions"><a class="header" href="#definitions">Definitions</a></h2> | ||
| <ul> | ||
| <li><strong>artifact</strong>: a deployable unit of software that is the result of a build process. This could be a library, a binary, a container image, or a well-known configuration file.</li> | ||
| <li><strong>release</strong>: a versioned artifact that is made available to the public. This could be a stable release, a beta release, or a release candidate.</li> | ||
| </ul> | ||
| <h2 id="desiderata"><a class="header" href="#desiderata">Desiderata</a></h2> | ||
| <h3 id="d1-apply-standardized-release-naming-convention"><a class="header" href="#d1-apply-standardized-release-naming-convention">D1: Apply standardized release naming convention</a></h3> | ||
| <p><strong>User Journey</strong>: All users can easily identify the type of release, software units, and versioning of Movement technologies.</p> | ||
| <p><strong>Justification</strong>: A standardized naming convention for releases will help developers understand the purpose of a release and the changes it contains. This will help developers make informed decisions about which releases to use.</p> | ||
| <h3 id="d2-ensure-release-artifacts-can-be-fetched-programmatically-and-used-to-run-applications"><a class="header" href="#d2-ensure-release-artifacts-can-be-fetched-programmatically-and-used-to-run-applications">D2: Ensure release artifacts can be fetched programmatically and used to run applications</a></h3> | ||
| <p><strong>User Journey</strong>: Operators can programmatically fetch release artifacts and use them to run applications.</p> | ||
| <p><strong>Justification</strong>: Operators should be able to automate the process of fetching and deploying release artifacts. This will help ensure that applications are always running the latest version of Movement technologies.</p> | ||
| <h3 id="d3-initiate-all-releases-from-source-control"><a class="header" href="#d3-initiate-all-releases-from-source-control">D3: Initiate all releases from source control</a></h3> | ||
| <p><strong>User Journey</strong>: Developers can initiate the release process from source control.</p> | ||
| <p><strong>Justification</strong>: Releasing from source control ensures that the release process is repeatable and that all changes are tracked. This will help developers understand the history of a release and troubleshoot any issues that arise.</p> | ||
| <h3 id="d4-define-standard-relationship-between-releases-and-governance"><a class="header" href="#d4-define-standard-relationship-between-releases-and-governance">D4: Define standard relationship between releases and governance</a></h3> | ||
| <p><strong>User Journey</strong>: All users can understand the relationship between releases and governance, i.e., how a particular release gets voted in as canonical for a given set of Movement technologies.</p> | ||
| <p><strong>Justification</strong>: A clear relationship between releases and governance will help users understand how releases are approved and what criteria they must meet. This will help users trust that releases are of high quality and meet the needs of the community.</p> | ||
| <h2 id="changelog"><a class="header" href="#changelog">Changelog</a></h2> | ||
|
|
||
| </main> | ||
|
|
||
| <nav class="nav-wrapper" aria-label="Page navigation"> | ||
| <!-- Mobile navigation buttons --> | ||
| <a rel="prev" href="../../../../../Review/primata/bridge-attestors/MD/md-21/index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> | ||
| <i class="fa fa-angle-left"></i> | ||
| </a> | ||
|
|
||
| <a rel="next prefetch" href="../../../../../Review/andygolay/md-26/MD/md-26/index.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> | ||
| <i class="fa fa-angle-right"></i> | ||
| </a> | ||
|
|
||
| <div style="clear: both"></div> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
|
|
||
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> | ||
| <a rel="prev" href="../../../../../Review/primata/bridge-attestors/MD/md-21/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> | ||
| <i class="fa fa-angle-left"></i> | ||
| </a> | ||
|
|
||
| <a rel="next prefetch" href="../../../../../Review/andygolay/md-26/MD/md-26/index.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> | ||
| <i class="fa fa-angle-right"></i> | ||
| </a> | ||
| </nav> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <script> | ||
| window.playground_copyable = true; | ||
| </script> | ||
|
|
||
|
|
||
| <script src="../../../../../elasticlunr.min.js"></script> | ||
| <script src="../../../../../mark.min.js"></script> | ||
| <script src="../../../../../searcher.js"></script> | ||
|
|
||
| <script src="../../../../../clipboard.min.js"></script> | ||
| <script src="../../../../../highlight.js"></script> | ||
| <script src="../../../../../book.js"></script> | ||
|
|
||
| <!-- Custom JS scripts --> | ||
|
|
||
|
|
||
| </div> | ||
| </body> | ||
| </html> |
Oops, something went wrong.