文件列表:

.depcheckrc (113, 2023-08-07)
.eleventyignore (10, 2023-08-07)
.eslintrc.json (235, 2023-08-07)
.releaserc.json (352, 2023-08-07)
CHANGELOG.md (15121, 2023-08-07)
LICENSE (1056, 2023-08-07)
data (0, 2023-08-07)
data\android (0, 2023-08-07)
data\android\2022-01.csv (1574, 2023-08-07)
data\backend (0, 2023-08-07)
data\backend\2021-07.csv (3135, 2023-08-07)
data\backend\2022-01.csv (5276, 2023-08-07)
data\ios (0, 2023-08-07)
data\ios\2021-06.csv (8374, 2023-08-07)
data\isec (0, 2023-08-07)
data\isec\2022-07.csv (6207, 2023-08-07)
data\js (0, 2023-08-07)
data\js\2021-06.csv (2669, 2023-08-07)
data\js\2021-07.csv (3630, 2023-08-07)
data\js\2022-07.csv (4871, 2023-08-07)
data\js\2023-07.csv (6036, 2023-08-07)
data\ops (0, 2023-08-07)
data\ops\2022-07.csv (5336, 2023-08-07)
data\qa (0, 2023-08-07)
data\qa\2021-12.csv (6444, 2023-08-07)
data\qa\2023-02.csv (7327, 2023-08-07)
data\qa\2023-07.csv (7405, 2023-08-07)
img (0, 2023-08-07)
img\radar.png (516216, 2023-08-07)
jest.config.json (732, 2023-08-07)
package.json (2136, 2023-08-07)
renovate.json (117, 2023-08-07)
src (0, 2023-08-07)
... ...

## Purpose [Zalando's answer](https://opensource.zalando.com/tech-radar/): > The Tech Radar is a tool to inspire and support engineering teams at Zalando to pick the best technologies for new projects; it provides a platform to share knowledge and experience in technologies, to reflect on technology decisions and continuously evolve our technology landscape. Based on the pioneering work of ThoughtWorks, our Tech Radar sets out the changes in technologies that are interesting in software development ” changes that we think our engineering teams should pay attention to and consider using in their projects. We've just _slightly_ modified [the original implementation](https://github.com/zalando/tech-radar) for our bloody enterprise requirements. ## Table of contents - [Getting started](#getting-started) - [Key features](#key-features) - [Requirements](#requirements) - [Install](#install) - [Usage](#usage) - [CLI](#cli) - [JS API](#js-api) - [Input-examples](#input-examples) - [CI/CD](#cicd) - [Customization](#customization) - [Contributing](#contributing) - [Add new data](#add-new-radar-data) - [Enhance the generator](#enhance-the-generator) - [Alternatives](#alternatives) - [License](#license) ## Key features * Builds radars by `csv`, `json` or `yaml` data * Renders a separate description page for each radar entry * Compares radars of the same scope with each other and shows the movement of points * Assembles all the radars refs on the main navigation page * Redirects scope urls to the latest version of their radars * CLI / JS / TS API ## Requirements * Node.js >= 14.13 * macOS / linux ## Install ```shell # yarn yarn add @qiwi/tech-radar # npm npm i @qiwi/tech-radar ``` ## Usage ### CLI ```shell # via local dep techradar --input "/path/to/files/*.{json, csv, yml}" --output /radar # through npx npx @qiwi/tech-radar --input "/path/to/files/*.{json, csv, yml}" --output /radar ``` | Option | Description | Default | |-------------|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | cwd | Current working dir | `process.cwd()` | | input | [glob pattern](https://github.com/mrmlnc/fast-glob) to find radar data: csv/json/yml | `/data/**/*.{json,csv,yml}` | | output | Output directory | `/radar` | | autoscope | identify same-scoped files as subversions of a single radar | `false` | | base-prefix | base context path for web statics | `tech-radar` | | nav-page | create navigation page | `false` | | nav-title | navigation page title | `“ Tech radars` | | nav-footer | navigation page footer | | | temp | temporary assets dir | [`tempy.directory()`](https://github.com/sindresorhus/tempy) | | templates | custom `11ty/nunjucks` compatible templates directory. Its contents will be merged into the default templates dir | ### JS API ```js import {run} from '@qiwi/tech-radar' await run({ input : 'data/*.{csv,json,yml}', output : 'dist', basePrefix: 'your project', autoscope: false }) ``` [JSDoc reference](https://qiwi.github.io/tech-radar/docs) ### Input examples

json

```json { "meta":{ "title": "tech radar js", "date": "2021-06-12" }, "data":[ { "name": "TypeScript", "quadrant": "languages-and-frameworks", "ring": "Adopt", "description": "° ·° –", "moved": "1" }, { "name": "Nodejs", "quadrant": "Platforms", "ring": "Adopt", "description": "", "moved": "" }, { "name": "codeclimate", "quadrant": "tools", "ring": "Trial", "description": "° °°·° °", "moved": "0" }, { "name": "“°°° °…°", "quadrant": "Techniques", "ring": "Assess", "description": "° °° °·… ", "moved": "-1" } ], "quadrantAliases": { "q1": "languages-and-frameworks", "q2": "platforms", "q3": "tools", "q4": "techniques" }, "quadrantTitles": { "q1": "Languages and frameworks", "q2": "Platforms", "q3": "Tools", "q4" :"Techniques" } } ```

yaml

```yaml meta: title: tech radar js date: "2021-06-11" data: - name: TypeScript quadrant: languages-and-frameworks ring: Adopt description: ° ·° – moved: 1 - name: Nodejs quadrant: Platforms ring: Adopt description: moved: - name: codeclimate quadrant: tools ring: Trial description: ° °°·° ° moved: 0 - name: “°°° °…° quadrant: Techniques ring: Assess description: ° °° °·… moved: -1 quadrantAliases: q1: - languages-and-frameworks - lnf - lang - framework q2: platforms q3: tools q4: techniques quadrantTitles: q1: Languages and frameworks q2: Platforms q3: Tools q4: Techniques ```

csv

``` title tech radar js === date 2021-06-18 === name, quadrant, ring, description, moved TypeScript, language, Adopt, "°, ·° –", 1 Nodejs, Platforms, Adopt, , codeclimate, tools, Trial, ° °°·° °, 0 “°°° °…°, Techniques, Assess, ° °° °·… , -1 === quadrant, alias q1, language q1, Languages-and-frameworks q2, Platforms q3, Tools q4, Techniques === quadrant, title q1, Languages and frameworks q2, Platforms q3, Tools q4, Techniques ```

### CI/CD Follow [gh-action usage example](https://github.com/qiwi/tech-radar/blob/master/.github/workflows/ci.yaml):

release_radar action

```yaml release_radar: name: Publish radar to gh-pages # https://github.community/t/trigger-job-on-tag-push-only/18076 if: github.event_name == 'push' && github.ref == 'refs/heads/master' runs-on: ubuntu-latest needs: test steps: - name: Checkuout uses: actions/checkout@v2 - name: Setup NodeJS uses: actions/setup-node@v2 with: node-version: 16 - name: Install deps run: yarn - name: Generate run: yarn generate - name: Publish gh-pages uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./dist commit_message: "docs: update tech-radar static" allow_empty_commit: true enable_jekyll: false ```

generator script

```json "scripts": { "generate": "node ./src/main/js/cli.mjs --input \"data/**/*.{csv,json,yml}\" --output dist --base-prefix tech-radar --autoscope true --nav-page true && touch dist/.nojekyll" }, ```

## Customization ### Group labels Every radar document provides its own definition of what each `quadrant` does represent. Change if necessary. ```csv quadrant, title q1, Languages and frameworks q2, Platforms q3, Tools q4, Techniques ``` ### Ring colors The easiest way to tweak up the look of your radar is by adding an alternative color scheme. `renderSettings` option is exactly for that: ```json { "svg_id": "radar", "width": 1450, "height": 1100, "colors": { "background": "#fff", "grid": "#bbb", "inactive": "#ddd" }, "rings": [ { "name": "ADOPT", "color": "#93c47d", "id": "adopt" }, { "name": "TRIAL", "color": "#93d2c2", "id": "trial" }, { "name": "ASSESS", "color": "#fbdb84", "id": "assess" }, { "name": "HOLD", "color": "#efafa9", "id": "hold" } ], "print_layout": true } ``` ### Templates For advanced view modification, you can use your own templates. Pass `template` option to navigate the dir, where your own custom `.njk` files are placed. Expected structure: ``` assets favicon.ico radar.css radar.js _data/ settings.json _includes footer.njk _layouts entries.njk page.njk radar.njk redirect.njk root.njk ``` ## Contributing Feel free to open new issues: bug reports, feature requests or questions. You're always welcome to suggest a PR. Just fork this repo, write some code, add some tests and push your changes. Any feedback is appreciated. ### Update the radar data 1. Clone the repo: `git clone git@github.com:qiwi/tech-radar.git` 2. Install deps: `yarn install` 3. Place a new radar data file to `data//.{csv|json|yaml}` 4. Fill it as shown in [examples](#input-examples) / [its siblings](https://github.com/qiwi/tech-radar/tree/master/data) 5. Run `yarn generate && yarn preview` 6. Follow [http://localhost:3000/](http://localhost:3000/). Assess the result 7. Push commit and create a pull request ### Enhance the generator 1. Clone the repo: `git clone git@github.com:qiwi/tech-radar.git` 2. Install deps: `yarn install` 3. Make some changes in `src/main/js` 4. Put some tests to `src/test/js` 5. Run `yarn test` 6. Repeat if necessary steps 1 to 3 7. Push commit and create a pull request ## Alternatives * [https://github.com/thoughtworks/build-your-own-radar](https://github.com/thoughtworks/build-your-own-radar) * [https://github.com/zalando/tech-radar](https://github.com/zalando/tech-radar) * [https://www.npmjs.com/package/@backstage/plugin-tech-radar](https://www.npmjs.com/package/@backstage/plugin-tech-radar) ## License [MIT](./LICENSE)

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：