architecture-as-code README

README проекта с github.com/finos/architecture-as-code. Одним файлом markdown: README.md.

FINOS - Graduated LFX Active Contributors OpenSSF Best Practices OpenSSF Baseline CodeQL OSV Scanner License Scanning for Maven License Scanning for Node.js

FINOS Common Architecture Language Model

Architecture as Code

Architecture as Code (AasC) aims to devise and manage software architecture via a human and machine readable and version-controlled codebase, fostering a robust understanding, efficient development, and seamless maintenance of complex software architectures.

This repository contains the Common Architecture Language Model (CALM) Specification, as well as capabilities being built to utilize the specification. This page lists the domains and capabilities being built by the official AasC community.

Whilst others are welcome to build their own capabilities, away from the AasC monorepo, we encourage you to join the community and contribute your projects to the AasC monorepo which has the benefits of being visible to the whole community; thereby attracting contributions and ensuring that changes to the manifest will be proactively built against your project.

Ready to get started? Check out the CALM tutorials.

Projects

Each project below is a subproject/codebase within this monorepo that is compiled and released independently (see security-insights.yml for a machine-readable list, per OSPS-QA-04.01).

Project Status Maintainers Builds
Common Architecture Language Model Active @rocketstack-matt, @jpgough-ms, @markscott-ms, @byrash Validation of CALM Samples
CLI, Shared, Models & Widget Framework Active @aidanm3341, @lbulanti-ms, @willosborne, @Thels, @LeighFinegold, @markscott-ms, @byrash Build CLI
CALM AI Active @rocketstack-matt, @jimthompson5802 No build, prompt tools only, managed separately to CLI for easier maintenance and broader reuse.
CALM Hub Active @jpgough-ms, @grahampacker-ms, @byrash Build Calm Hub
CALM Hub UI Active @aidanm3341, @aamanrebello, @yoofitt96, @byrash Build CALM Hub UI
CALM-Server Active @rocketstack-matt, @markscott-ms Build CALM Server
CALM Hub Extensions Active @rocketstack-matt, @markscott-ms Build CALM Hub Extensions
Docs Active @rocketstack-matt, @jimthompson5802 Sync Docs to S3 Build Docs
CALM Learning Lab Active @rocketstack-matt Build CALM Lab Sync Lab to S3
CALM Canvas VSCode Plugin Active @rocketstack-matt, @markscott-ms, @byrash Build CALM Canvas
CALM Guard Experimental @gjs-opsflo, @eddie-knight Build CALM Guard

Roadmap

Roadmap

Click the roadmap to view the interactive version with clickable cards.

Getting Involved

Architecture as Code was developed as part of the DevOps Automation Special Interest Group before graduating as a top level project in it's own right. Our community Zoom meetups take place on the fourth Tuesday of every month, see here for upcoming and previous meetings. For active contributors we have Office Hours every Thursday, see the FINOS Event Calendar for meeting details.

Have an idea or feedback? Raise an issue in this repository.

Project repositories

Architecture as Code is one of three repositories that make up the FINOS Architecture as Code project, also known as CALM:

Repository Contents
architecture-as-code This repository. The tools that use the CALM specification: CLI, server, shared libraries, data models, widgets, CALM Hub and its UI, the VS Code extension, CALM Guard, the documentation site and CALM Lab.
calm-schema The CALM Meta Schema, its documentation and validation test suite. Published to npm as @finos/calm-schema, which the tools here depend on, and to calm.finos.org.
calm-governance The governance home: project-wide governance, contribution guidelines, Maintainer roster and Code of Conduct. Holds no code.

Propose a schema change in calm-schema, not here.

Contributing

Architecture as Code operates as a monorepo of the projects that are being built to utilize the CALM specification.

We accept contributions via Pull Request, to make a contribution:

  1. Pick an issue you are interested in contributing to (or raise one yourself) and speak to the lead maintainers about what you plan to do either in the issue itself or come to a meetup. Some issues are suggested for first time contributors.
  2. Fork the repo (https://github.com/finos/architecture-as-code/fork)
  3. Create your feature branch (git checkout -b feature/fooBar)
  4. Read this repository's contribution guidelines, the project-wide contribution guidelines and the Community Code of Conduct
  5. Commit your changes (git commit -am 'Add some fooBar')
  6. Push to the branch (git push origin feature/fooBar)
  7. Create a new Pull Request

Support and Security

Support is community-based and best-effort: ask in a Support Question issue or at Office Hours. SUPPORT.md states which releases are supported and when a release stops receiving security updates. To report a vulnerability privately, follow SECURITY.md, which also holds the dependency and code scanning policy and instructions for verifying release integrity. The project's threat model is in THREAT_MODEL.md.

Governance

The project's governance policies, Maintainer roster and Code of Conduct are maintained in finos/calm-governance and apply across every repository in the project.

Document Covers
GOVERNANCE.md Roles, contribution rules, Maintainer voting, and how Maintainers are added and removed
MAINTAINERS.md The project-wide Maintainer roster and the Lead Maintainer
MAINTAINERS_GUIDELINES.md Repository-specific maintainer guidance for review, triage, quality, releases, and onboarding in this monorepo
CONTRIBUTING.md Project-wide contribution guidelines
CODE_OF_CONDUCT.md The Code of Conduct all participants are subject to

The maintainers of each subproject in this monorepo are listed in the Projects table above.

A contributor must be nominated and approved by a vote of the existing Maintainers before they are granted write access to this repository, as set out in GOVERNANCE.md.

GitHub actions

There aren't many standards to follow when it comes to Github actions - but some good rules of thumb for this project are;

Language Dependencies

TypeScript Packages

Currently we have three typescript packages - two of which are managed via npm workspaces and one which is just raw npm. How these are built and manages slightly differs until they are all under the same worksapce - please look at their related github actions to learn how to build/test each of them.

License

Copyright FINOS

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0

architecture-as-code (finos/architecture-as-code)

Ищем в базе…

Что это такое?Architecture as Code (CALM) — это проект FINOS для описания архитектуры программного обеспечения в виде кодовой базы под контролем версий, которую читают и люди, и машины, вместо статичных диаграмм, а также набор инструментов вокруг этой спецификации.
Это один инструмент или целый набор проектов?Это монорепозиторий, объединяющий несколько отдельных проектов, построенных вокруг спецификации Common Architecture Language Model (CALM): CLI, общие библиотеки и модели данных, сервер CALM Hub со своим интерфейсом, расширение для VS Code, сайт документации, а также экспериментальные CALM Guard и CALM Studio.
Как начать работу с CALM?Начните с учебных материалов CALM, на которые ведёт ссылка из этого README; оттуда вы перейдёте к CLI и спецификации CALM, чтобы смоделировать свою архитектуру.
Нужны ли Node.js и npm, чтобы пользоваться инструментами отсюда?Да, инструменты написаны на TypeScript и распространяются как пакеты npm: часть из них управляется через npm workspaces, а один собирается как обычный npm-пакет.
Все ли входящие в состав инструменты готовы к промышленной эксплуатации?Нет. В таблице статусов CLI, общие библиотеки, CALM Hub и его интерфейс, CALM-Server, документация, Learning Lab и плагин для VS Code отмечены как Active, а CALM Guard и CALM Studio по-прежнему Experimental.
Что такое CALM?CALM (Common Architecture Language Model) — это основная спецификация в этом репозитории для описания архитектуры программного обеспечения в машиночитаемом виде; каждый инструмент здесь (CLI, сервер, виджеты, плагин для VS Code) создан для работы с ней.
Что такое CALM Hub?CALM Hub — серверный компонент с собственным веб-интерфейсом для хранения и обмена моделями архитектуры CALM. Он разрабатывается и поддерживается как активный подпроект этого монорепозитория.
Почему для этого проекта есть три отдельных репозитория FINOS?В репозитории architecture-as-code находятся инструменты (CLI, сервер, Hub, расширение для VS Code, CALM Guard и Studio), calm-schema содержит только мета-схему CALM и её валидаторы, а calm-governance — документы об управлении проектом без кода.
Есть ли расширение для VS Code?Да, плагин CALM VSCode указан как активный подпроект, который поддерживается вместе с CLI и другими инструментами в этом монорепозитории.
Какие есть похожие проекты?vibex, drawio-skill, archify, x18n, dsh-std, d2, svg-diagram, design.md
Автор
finos
Размер
116.2 MB
Звёзды
467
Возраст
2 г
Коммиты · 90 дней