Skip to content

ci: add CI workflow checking Markdown formatting - #16

Merged
AlekseyManetov merged 4 commits into
mainfrom
ci/add-ci-workflow
Nov 6, 2026
Merged

AlekseyManetov merged 4 commits into
mainfrom
ci/add-ci-workflow

Conversation

@barmac

@barmac barmac commented Nov 6, 2026

Copy link
Copy Markdown
Member

Proposed Changes

Add a CI workflow that checks the Markdown formatting of this repository, modelled on bpmn-io/internal-docs (Node 24 only, npm ci, npm run all). Unlike internal-docs, it only checks and does not auto-commit formatting changes. The existing docs are formatted once via a separate style: format docs commit, and issue and pull request templates are excluded via .remarkignore to keep them byte-exact.
Steps to try out: see the CI run on this PR.

Checklist

Ensure you provide everything we need to review your contribution:

  • Contribution meets our definition of done
  • Pull request establishes context
    • Link to related issue(s), i.e. Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}
    • Brief textual description of the changes
    • Screenshots or short videos showing UI/UX changes
    • Steps to try out, i.e. using the @bpmn-io/sr tool

🤖 Generated with Claude Code

barmac and others added 3 commits November 6, 2026 16:17
Add remark based formatting and linting via `npm run all`. Issue and pull request templates are ignored as they must stay byte-exact.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Verify Markdown formatting on push and pull request.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@barmac
barmac requested review from a team and a balanced review from Copilot November 6, 2026 15:17
@bpmn-io-tasks bpmn-io-tasks Bot added the needs review Review pending label Nov 6, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The CI formatting check can pass while committed Markdown remains unformatted because it fails on warnings but does not detect formatting changes to tracked files.

1 open issue
What changed in this PR

This PR adds Markdown formatting CI to the organization’s shared community-resource repository and normalizes existing documentation.

Changes:

  • Adds a Node.js 24 workflow running npm ci and npm run all.
  • Configures Remark with the bpmn-io preset and excludes issue and pull request templates.
  • Applies consistent Markdown formatting across existing docs.
File Description
SECURITY.md Normalizes whitespace and email-link formatting.
README.md Cleans up spacing and the final newline.
profile/​README.md Removes trailing whitespace and extra spacing.
package.json Adds Remark dependencies, configuration, and scripts.
AGENTS.md Standardizes lists, emphasis, and shell code fences.
.remarkignore Excludes issue and pull request templates from formatting.
.gitignore Ignores installed Node.js dependencies.
.github/​workflows/​CI.yml Adds the Node.js 24 Markdown CI workflow.
.github/​CONTRIBUTING.md Normalizes formatting and corrects table-of-contents text.
.github/​CODE_OF_CONDUCT.md Normalizes emphasis, quotes, and spacing.

Review effort: Balanced

Comment thread .github/workflows/CI.yml Resolved
Co-authored-by: AlekseyManetov <14283670+AlekseyManetov@users.noreply.github.com>
@fake-join fake-join Bot added needs:ci-approval Requires approval of workflow runs and removed needs:ci-approval Requires approval of workflow runs labels Nov 6, 2026
@AlekseyManetov
AlekseyManetov requested a balanced review from Copilot November 6, 2026 16:04
Copilot AI requested a review from AlekseyManetov November 6, 2026 16:04

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

There are no active review issues for the Markdown linting CI and documentation-formatting changes.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@AlekseyManetov
AlekseyManetov merged commit c55a11d into main Nov 6, 2026
7 checks passed
@bpmn-io-tasks bpmn-io-tasks Bot removed the needs review Review pending label Nov 6, 2026
@AlekseyManetov
AlekseyManetov deleted the ci/add-ci-workflow branch November 6, 2026 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants