Merge pull request #107 from svenfuchs/automation/generate-readme

Update workflow to generate & commit README.md if necessary

.github/workflows/readme.yaml

@@ -13,6 +13,10 @@ jobs:
     name: Ensure readme.md is up to date
     if: "contains(github.event.commits[0].message, '[ci skip]') == false"
     runs-on: ubuntu-latest
+    permissions:
+      # Give the default GITHUB_TOKEN write permission to commit and push the
+      # added or changed files to the repository.
+      contents: write
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -23,6 +27,10 @@ jobs:
           bundler-cache: true
       - name: generate readme
         run: script/generate_readme
+      - name: Commit updated README.md
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          file_pattern: 'README.md'
       - name: check that new readme is identical to the old
         run: |
           if [ -z "$(git status --porcelain README.md)" ]

README.md

@@ -1,4 +1,4 @@
-# gem release [![Build Status](https://secure.travis-ci.org/svenfuchs/gem-release.svg)](http://travis-ci.org/svenfuchs/gem-release)
+# gem release
 
 This gem plugin aims at making gem development easier by automating repetitive work based on conventions, configuration, and templates.
 
@@ -8,10 +8,10 @@ It adds the commands `bootstrap`, `gemspec`, `bump`, `tag` and a `release` to th
 | ---------------------- | ------------ |
 | Gem name               |  gem-release |
 | License                |  [MIT](https://github.com/svenfuchs/gem-release/blob/master/LICENSE.md) |
-| Version                |  [![Gem Version](https://img.shields.io/gem/v/gem-release.svg?style=flat-square)](http://badge.fury.io/rb/gem-release) |
+| Version                |  [![Gem Version](https://img.shields.io/gem/v/gem-release.svg?style=flat-square)](https://badge.fury.io/rb/gem-release) |
 | Continuous integration |  [![GitHub Build Status](https://img.shields.io/github/actions/workflow/status/svenfuchs/gem-release/tests.yaml?branch=master&style=flat-square)](https://github.com/svenfuchs/gem-release/actions/workflows/tests.yaml) |
 | Test coverage          |  [![Coverage Status](https://img.shields.io/coveralls/svenfuchs/gem-release.svg?style=flat-square)](https://coveralls.io/r/svenfuchs/gem-release) |
-| Documentation          |  [Documentation](http://rdoc.info/github/svenfuchs/gem-release/frames) |
+| Documentation          |  [Documentation](https://www.rubydoc.info/gems/gem-release) |
 | Credits                |  [Contributors](https://github.com/svenfuchs/gem-release/graphs/contributors) |
 
 # Table of contents

README.md.erb

@@ -1,4 +1,4 @@
-# gem release [![Build Status](https://secure.travis-ci.org/svenfuchs/gem-release.svg)](http://travis-ci.org/svenfuchs/gem-release)
+# gem release
 
 This gem plugin aims at making gem development easier by automating repetitive work based on conventions, configuration, and templates.
 
@@ -8,10 +8,10 @@ It adds the commands `bootstrap`, `gemspec`, `bump`, `tag` and a `release` to th
 | ---------------------- | ------------ |
 | Gem name               |  gem-release |
 | License                |  [MIT](https://github.com/svenfuchs/gem-release/blob/master/LICENSE.md) |
-| Version                |  [![Gem Version](https://img.shields.io/gem/v/gem-release.svg?style=flat-square)](http://badge.fury.io/rb/gem-release) |
+| Version                |  [![Gem Version](https://img.shields.io/gem/v/gem-release.svg?style=flat-square)](https://badge.fury.io/rb/gem-release) |
 | Continuous integration |  [![GitHub Build Status](https://img.shields.io/github/actions/workflow/status/svenfuchs/gem-release/tests.yaml?branch=master&style=flat-square)](https://github.com/svenfuchs/gem-release/actions/workflows/tests.yaml) |
 | Test coverage          |  [![Coverage Status](https://img.shields.io/coveralls/svenfuchs/gem-release.svg?style=flat-square)](https://coveralls.io/r/svenfuchs/gem-release) |
-| Documentation          |  [Documentation](http://rdoc.info/github/svenfuchs/gem-release/frames) |
+| Documentation          |  [Documentation](https://www.rubydoc.info/gems/gem-release) |
 | Credits                |  [Contributors](https://github.com/svenfuchs/gem-release/graphs/contributors) |
 
 # Table of contents