How to make semantic-release do a release on a docs commit?

Question

I started using semantic-release for some projects I have, is there a way to "force" a patch release on a docs: commit?

Why on docs? Because it publishes on npm too and I want to have the latest documentation there.

I also use dependabot to keep my dependencies up to date, should have patch releases for updated dependencies too, since a fix in a dependency is a potential fix in my project too.

score 0 · Answer 1 · answered Feb 23 '21 at 16:24

the plugin in charge of deciding if your changes should trigger a release is "@semantic-release/commit-analyzer" (no need to install it specifically), all you need to config is the "releaseRules" value:

  "release": {
    "branches": [
      "main"
    ],
    "plugins": [
      [
        "@semantic-release/commit-analyzer",
        {
          "preset": "angular",
          "releaseRules": [
            {
              "type": "docs",
              "release": "patch"
            }
          ]
        }
      ],
      "@semantic-release/release-notes-generator",
      "@semantic-release/changelog",
      "@semantic-release/npm",
      "@semantic-release/git",
      ...
    ]
  },

Thanks! What should I put the that config? Is that the package.json? — Alvaro Castro, Feb 23 '21 at 23:13

How to make semantic-release do a release on a docs commit?

1 Answers1