{"id":20216444,"url":"https://github.com/lauravuo/alexjs-orb","last_synced_at":"2025-03-03T11:23:00.514Z","repository":{"id":56268722,"uuid":"307730060","full_name":"lauravuo/alexjs-orb","owner":"lauravuo","description":"CircleCI orb for alex.js","archived":false,"fork":false,"pushed_at":"2020-11-17T15:42:39.000Z","size":32,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-13T22:18:04.165Z","etag":null,"topics":["alex","ci","circleci","circleci-orb","continuous-integration","documentation","hacktoberfest","linting"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lauravuo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-27T14:39:59.000Z","updated_at":"2020-11-17T15:42:37.000Z","dependencies_parsed_at":"2022-08-15T15:40:55.338Z","dependency_job_id":null,"html_url":"https://github.com/lauravuo/alexjs-orb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lauravuo%2Falexjs-orb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lauravuo%2Falexjs-orb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lauravuo%2Falexjs-orb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lauravuo%2Falexjs-orb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lauravuo","download_url":"https://codeload.github.com/lauravuo/alexjs-orb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241653578,"owners_count":19997703,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alex","ci","circleci","circleci-orb","continuous-integration","documentation","hacktoberfest","linting"],"created_at":"2024-11-14T06:28:07.992Z","updated_at":"2025-03-03T11:23:00.494Z","avatar_url":"https://github.com/lauravuo.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# alexjs-orb\n\n[![CircleCI Build Status](https://circleci.com/gh/lauravuo/alexjs-orb.svg?style=shield \"CircleCI Build Status\")](https://circleci.com/gh/lauravuo/alexjs-orb) \n[![CircleCI Orb Version](https://img.shields.io/badge/endpoint.svg?url=https://badges.circleci.io/orb/lauravuo/alexjs-orb)](https://circleci.com/orbs/registry/orb/lauravuo/alexjs-orb)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n\nCircleCI orb for [Alex](https://alexjs.com/). The tool lints documentation files for insensitive writing.\n\n## Usage\n\nExample for linting all project documentation files:\n\n```yaml\nversion: 2.1\n\norbs:\n  alexjs-orb: lauravuo/alexjs-orb@0.0.1\n\nworkflows:\n  lint:\n    jobs:\n      alexjs-orb/lint\n\n```\n\n**Example with orb configuration:**\n\n* *version* defines Alex version\n* *args* are arguments passed to Alex \n\nCheck [Alex docs](https://github.com/get-alex/alex) for more tips how to configure the linting.\n\n```yaml\nversion: 2.1\n\norbs:\n  alexjs-orb: lauravuo/alexjs-orb@0.0.1\n\nworkflows:\n  lint:\n    jobs:\n      - alexjs-orb/lint:\n          version: \"9.0.1\"\n          args: ./src/tests/test.md\n\n```\n\n## Resources\n\n[CircleCI Orb Registry Page](https://circleci.com/orbs/registry/orb/lauravuo/alexjs-orb) - The official registry page of this orb for all versions, executors, commands, and jobs described.\n[CircleCI Orb Docs](https://circleci.com/docs/2.0/orb-intro/#section=configuration) - Docs for using and creating CircleCI Orbs.\n\n### How to Contribute\n\nWe welcome [issues](https://github.com/lauravuo/alexjs-orb/issues) to and [pull requests](https://github.com/lauravuo/alexjs-orb/pulls) against this repository!\n\n### How to Publish\n* Create and push a branch with your new features.\n* When ready to publish a new production version, create a Pull Request from _feature branch_ to `main`.\n* The title of the pull request must contain a semver tag: `[semver:\u003csegment\u003e]` where `\u003csegment\u003e` is replaced by one of the following values.\n\n| Increment | Description|\n| ----------| -----------|\n| major     | Issue a 1.0.0 incremented release|\n| minor     | Issue a x.1.0 incremented release|\n| patch     | Issue a x.x.1 incremented release|\n| skip      | Do not issue a release|\n\nExample: `[semver:major]`\n\n* Squash and merge. Ensure the semver tag is preserved and entered as a part of the commit message.\n* On merge, after manual approval, the orb will automatically be published to the Orb Registry.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flauravuo%2Falexjs-orb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flauravuo%2Falexjs-orb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flauravuo%2Falexjs-orb/lists"}