open-index/open-npm huggingface dataset:
npm package: @gliech/semantic-release-config-base
Description: shared datastructures for other semantic-release shareable configurations
Author: gliech
Latest version: 1.1.2

# [@gliech/semantic-release-config-base][1]

This repository contains a semantic-release shareable configuration, which is
supposed to serve as the basis for other shareable configurations. For this
reason it does not define a list of plugins, but instead defines various options
that plugins defined in other shareable configurations will use, if they are not
overwritten.

## Features
- Adheres closely to the [conventional commits][4] standard and uses the
  [conventional-changelog-conventionalcommits][5] preset to analyze commit
  message, but creates custom release and changelog messages more closely
  resembeling the semantic-release default format defined in the angular preset.
- Defines a bunch of non-standard commit types and how to handle them. The
  general rule is that only actual changes to the main project code will trigger
  a new release. See [commit_types.yml](commit_types.yml) for details.
- Defines a commit type **amend**, which will create a new patch release if
  pushed on its' own on a release branch, but is otherwise completely invisible.
  This is meant as a tool to create fixes for unreleased features without
  creating nonsensical changelog messages, or erasing development history by
  actually amending commits.
- Supports both **master** and **main** as repository default and release
  branch. Something that semantic-release as of major version 17 surprisingly
  does not do by default.

## Shareable configurations built on top of @gliech/semantic-release-config-base

- [@gliech/semantic-release-config-github-generic][2]
- [@gliech/semantic-release-config-github-npm][3]

## License

This project is licensed under the terms of the [BSD 4-Clause License](LICENSE)

[1]: https://www.npmjs.com/package/@gliech/semantic-release-config-base
[2]: https://www.npmjs.com/package/@gliech/semantic-release-config-github-generic
[3]: https://www.npmjs.com/package/@gliech/semantic-release-config-github-npm
[4]: https://www.conventionalcommits.org/en/v1.0.0/
[5]: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits
npm package: @gliech/semantic-release-config-github-ansible-role
Description: semantic-release shareable configuration for ansible galaxy roles
Author: gliech
Latest version: 1.1.1

# [@gliech/semantic-release-config-github-ansible-role][1]

> **Disclaimer:** This configuration does not do much by itself and was mainly
> created so that I won't have to replace configurations in all of my
> repositories if I decide to change the way I do semantic versioning.

A shareable semantic-release config that publishes ansible roles to
[Ansible Galaxy][3]. Requires the following environment variables to publish
the role:

| Name                     | Description                                                                                                       |                                        
| :----------------------: | ----------------------------------------------------------------------------------------------------------------- |
| `ANSIBLE_GALAXY_API_KEY` | Ansible Galaxy API key that can be found at <https://galaxy.ansible.com/me/preferences>                           |
| `GITHUB_REPOSITORY`      | Name of the role repository on GitHub in the form of `owner/repo` (automatically set in GitHub Actions Workflows) |

This shareable configuration uses [@gliech/semantic-release-config-base][2],
which serves as the source for most changes to the default options for plugins
included here.

## Usage

As this module and [@gliech/semantic-release-config-base][2] contain all
necessary modules as dependencies, you only have to install the module itself.

In addition this repository provides a reusable GitHub Actions workflow that you
can use in your `.github/workflows`. 

```yaml
---
on:
  push:
name: main
jobs:
  release:
    name: test & release
    uses:
      gliech/semantic-release-config-github-ansible-role/.github/workflows/test_release.yml@v1
    secrets:
      ANSIBLE_GALAXY_API_KEY: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
```

The reusable workflow also defines 3 optional inputs:

| Name                     | Type    | Default | Description                                                                      |                                        
| :----------------------: | :-----: | :-----: | -------------------------------------------------------------------------------- |
| `semrel_config_version`  | string  | `"1.x"` | Can be used to pin the version of the npm module used                            |
| `syntax_checks`          | boolean | `true`  | Can be used to disable the yamllint and ansible-lint checks done by the workflow |
| `molecule_test`          | boolean | `true`  | Can be used to disable the molecule test done by the workflow                    |

## License

This project is licensed under the terms of the [BSD 4-Clause License](LICENSE)

[1]: https://www.npmjs.com/package/@gliech/semantic-release-config-github-ansible-role
[2]: https://www.npmjs.com/package/@gliech/semantic-release-config-base
[3]: https://galaxy.ansible.com/
npm package: @gliech/semantic-release-config-github-generic
Description: semantic-release shareable configuration for generic (non npm) github projects
Author: gliech
Latest version: 1.1.0

# [@gliech/semantic-release-config-github-generic][1]

> **Disclaimer:** This configuration does not do much by itself and was mainly
> created so that I won't have to replace configurations in all of my
> repositories if I decide to change the way I do semantic versioning.

A shareable semantic-release config for projects that are on github and do not
need any special build or release steps.

This shareable configuration uses [@gliech/semantic-release-config-base][2],
which serves as the source for most changes to the default options for plugins
included here.

## Usage

As this module and [@gliech/semantic-release-config-base][2] contain all
necessary modules as dependencies, you only have to install the module itself.

In addition this repository provides a reusable GitHub Actions workflow that you
can use in your `.github/workflows`. 

```yaml
---
on:
  push:
name: main
jobs:
  release:
    name: semantic release
    uses:
      gliech/semantic-release-config-github-generic/.github/workflows/release.yml@v1
```

The reusable workflow also defines one optional input, `semrel_config_version`
that can be used to pin the version of the npm module used in the workflow. It
defaults to `"1.x"`

## License

This project is licensed under the terms of the [BSD 4-Clause License](LICENSE)

[1]: https://www.npmjs.com/package/@gliech/semantic-release-config-github-generic
[2]: https://www.npmjs.com/package/@gliech/semantic-release-config-base
npm package: @gliech/semantic-release-config-github-npm
Description: semantic-release shareable configuration for github projects that publish npm packages
Author: gliech
Latest version: 1.3.1

# [@gliech/semantic-release-config-github-npm][1]

> **Disclaimer:** This configuration does not do much by itself and was mainly
> created so that I won't have to replace configurations in all of my
> repositories if I decide to change the way I do semantic versioning.

A shareable semantic-release config for npm packages with code hosted on github.

This shareable configuration uses [@gliech/semantic-release-config-base][2],
which serves as the source for most changes to the default options for plugins
included here.

## Usage

As this module and [@gliech/semantic-release-config-base][2] contain all
necessary modules as dependencies, all you need to do to use semantic-release
is add just this module to your package.json

```json
{
  ...
  "devDependencies": {
    "@gliech/semantic-release-config-github-npm": "^1.2.0"
  },
  "release": {
    "extends": ["./index.js"]
  }
}
```

In addition this repository provides a reusable GitHub Actions workflow that you
can use in your `.github/workflows`.

```yaml
---
on:
  push:
name: main
jobs:
  release:
    name: semantic release
    uses: gliech/semantic-release-config-github-npm/.github/workflows/release.yml@v1
    secrets:
      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
```

## License

This project is licensed under the terms of the [BSD 4-Clause License](LICENSE)

[1]: https://www.npmjs.com/package/@gliech/semantic-release-config-github-npm
[2]: https://www.npmjs.com/package/@gliech/semantic-release-config-base
npm package: @gliech/semantic-release-generic-github-config
Description: semantic-release shareable configuration for generic (non npm) github projects
Author: gliech
Latest version: 1.3.2
Deprecated: please use @gliech/semantic-release-config-github-generic instead

# **ATTENTION! this package is deprecated please use [@gliech/semantic-release-config-github-generic][2] instead**

# [@gliech/semantic-release-generic-github-config][1]

> **Disclaimer:** The *code* that exports the preset is pretty bad atm and the
> whole package mainly exists so that I can use the preset in my own projects
> and won't have to replace configurations in all of my repositories if I decide
> to change the flavor of semantic versioning / conventional commmits I use.

A shareable semantic-release config for projects that are on github and do not
need any special build or release steps.

- creates a tag and github release
- updates the ```CHANGELOG.md```

The commit parsing is based on the conventionalcommits preset but adds a bunch
of commit types and changes a few of the commit-type → release-type mappings.

The styling of release-notes and changelog was changes to more closely resemble
the angular preset.

## License

This project is licensed under the terms of the [BSD 4-Clause License](LICENSE)

[1]: https://www.npmjs.com/package/@gliech/semantic-release-generic-github-config
[2]: https://www.npmjs.com/package/@gliech/semantic-release-config-github-generic