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 的一个项目,它把软件架构描述为既便于人阅读、也便于机器读取、并可进行版本控制的代码库,而不是静态图表;此外,项目还围绕这一规范构建了一套工具。
这是一个工具,还是一整套项目?它是一个单体仓库(monorepo),打包了几个围绕通用架构语言模型(CALM)规范构建的独立项目:一个 CLI、共享库和数据模型、一个带有自身 UI 的服务器 CALM Hub、一个 VS Code 扩展、一个文档站点,以及实验性的 CALM Guard 和 CALM Studio。
我该如何开始使用 CALM?从本 README 中链接的 CALM 教程开始;之后即可使用 CLI,并依据 CALM 规范对你的架构进行建模。
使用这里的工具需要安装 Node.js 和 npm 吗?需要。这些工具使用 TypeScript 编写,并以 npm 包的形式发布,其中部分通过 npm workspaces 管理,另有一个以普通 npm 方式管理。
所有附带的工具都已可用于生产环境了吗?并非如此。状态表中,CLI、共享库、CALM Hub 及其 UI、CALM-Server、文档、Learning Lab 和 VS Code 插件被标为活跃,而 CALM Guard 和 CALM Studio 仍处于实验性阶段。
什么是 CALM?CALM(通用架构语言模型)是本仓库中的核心规范,用于以机器可读的方式描述软件架构;这里的每个工具(CLI、服务器、组件、VS Code 插件)都是为读取该规范而构建的。
什么是 CALM Hub?CALM Hub 是一个服务器组件,并配有自己的 Web UI,用于存储和共享 CALM 架构模型;它是本单体仓库中一个活跃的子项目,由团队持续构建和维护。
为什么这个项目有三个独立的 FINOS 仓库?architecture-as-code 存放各类工具(CLI、服务器、Hub、VS Code 扩展、CALM Guard/Studio);calm-schema 仅存放 CALM 元模式及其校验器;calm-governance 存放项目层面的治理文档,不包含代码。
有 VS Code 扩展吗?有。CALM VSCode Plugin 被列为活跃的子项目,与本单体仓库中的 CLI 及其他工具一同维护。
有哪些类似的项目?vibex, drawio-skill, archify, x18n, dsh-std, d2, svg-diagram, design.md
作者
finos
大小
116.2 MB
星标
467
时长
2年
提交 · 90 天