https://github.com/technologiestiftung/semantic-release-config

https://github.com/technologiestiftung/semantic-release-config

Last synced: 30 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/technologiestiftung/semantic-release-config
• Owner: technologiestiftung
• License: mit
• Created: 2022-09-01T07:42:45.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T08:01:25.000Z (2 months ago)
• Last Synced: 2024-10-21T10:56:55.617Z (2 months ago)
• Language: JavaScript
• Size: 305 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
![](https://img.shields.io/badge/Built%20with%20%E2%9D%A4%EF%B8%8F-at%20Technologiestiftung%20Berlin-blue)

[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

# shareable semantic-release-config

shareable semantic-release-config

## Installation

```bash

npm install @technologiestiftung/semantic-release-config

```

## Usage

Add file called release.config.js to your repo

```js

module.exports = {

  extends: '@technologiestiftung/semantic-release-config',

};

```

If you use a staging/production environment, where staging is the branch staging and production is deployed from main it is wise to add an additional package to do some backmerging. Install it using npm `npm i -D @saithodev/semantic-release-backmerge` and add it as a plugin to your config, referencing the right branches.

```

module.exports = {

  branches: [

        { name: "main" },

        { name: "staging", channel: "pre/rc", prerelease: "rc" }, // `prerelease` is built with the template `${name.replace(/^pre\\//g, "")}`

    ],

plugins: [

		[

			"@saithodev/semantic-release-backmerge",

			{

				backmergeBranches: [{from: "main", to: "staging"}],

				backmergeStrategy: "merge",

			},

		],

	],

  }

```

Overwrite possible keys. See the [semantic-release docs](https://semantic-release.gitbook.io/semantic-release/usage/configuration#extends). If operating with protected branches, you can need to set the option `persist-credentials: false` in your workflow file on the `actions/checkout@v3` step.

```yaml

steps:

  - uses: actions/checkout@v3

    with:

      persist-credentials: false

```

See also this repos [.github/workflows/test-and-release.yml](./.github/workflows/test-and-release.yml) how to use this in GitHub Actions.

Needs a Personal Access Token with `repo` scope to be set as `GH_TOKEN` in the repo secrets and a `NPM_TOKEN` with `write` scope.

## Development

Do your thing. Early stages.

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Fabian Morón Zirfas
📖 💻 🚇

      
Lucas Vogel
📖 🤔 👀 💻

      
Ingo Hinterding
📖

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## Content Licensing

## Credits

  

    

      Made by 

        


        


        

      

    

    

      A project by 

        


        


        

      

    

    

      Supported by 

        


        


        

      

    

  

## Related Projects

- [github.com/semantic-release/gitlab-config](https://github.com/semantic-release/gitlab-config)