diff --git a/README.example.md b/README.example.md deleted file mode 100644 index 4f10647e..00000000 --- a/README.example.md +++ /dev/null @@ -1,49 +0,0 @@ -# - -<description> - -<a name="toc"></a> - -## Table of contents - -- [Badges](#badges) -- [License](#license) - -<a name="badges"></a> - -## Badges - -| Badge | Description | Service | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | -------------------- | -| <a href="https://github.com/prettier/prettier#readme"><img alt="code style" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"></a> | Code style | Prettier | -| <a href="https://conventionalcommits.org"><img alt="Conventional Commits: 1.0.0" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square"></a> | Commit style | Conventional Commits | -| <a href="https://github.com/vidavidorra/<repo-name>/actions"><img alt="GitHub workflow status" src="https://img.shields.io/github/workflow/status/vidavidorra/<repo-name>/Lint%20commit%20messages?style=flat-square"></a> | Lint commit messages | GitHub Actions | -| <a href="https://github.com/vidavidorra/<repo-name>/actions"><img alt="GitHub workflow status" src="https://img.shields.io/github/workflow/status/vidavidorra/<repo-name>/Lint?style=flat-square"></a> | Lint | GitHub Actions | - -<a name="license"></a> - -## License - -This project is licensed under the [GPLv3 license](https://www.gnu.org/licenses/gpl.html). - -Copyright © 2019-2020 Jeroen de Bruijn - -<details><summary>License details.</summary> -<p> - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see <http://www.gnu.org/licenses/>. - -The full text of the license is available in the [LICENSE](LICENSE.md) file in this repository and [online](https://www.gnu.org/licenses/gpl.html). - -</details> diff --git a/README.md b/README.md index 189fb182..45a51c9e 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,24 @@ -# repo-template +# GitHub Action Renovate -A template for creating new repositories. +GitHub Action to run Renovate self-hosted. <a name="toc"></a> ## Table of contents - [Badges](#badges) -- [Setup](#setup) -- [Checklist](#checklist) - [License](#license) <a name="badges"></a> ## Badges -| Badge | Description | Service | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------- | -------------------- | -| <a href="https://github.com/prettier/prettier#readme"><img alt="code style" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"></a> | Code style | Prettier | -| <a href="https://conventionalcommits.org"><img alt="Conventional Commits: 1.0.0" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square"></a> | Commit style | Conventional Commits | -| <a href="https://github.com/vidavidorra/repo-template/actions"><img alt="GitHub workflow status" src="https://img.shields.io/github/workflow/status/vidavidorra/repo-template/Lint%20commit%20messages?style=flat-square"></a> | Lint commit messages | GitHub Actions | -| <a href="https://github.com/vidavidorra/repo-template/actions"><img alt="GitHub workflow status" src="https://img.shields.io/github/workflow/status/vidavidorra/repo-template/Lint?style=flat-square"></a> | Lint | GitHub Actions | - -<a name="setup"></a> - -## Setup - -After a new repository using this template has been created, make the . - -1. Create a temporary checklist and replace the readme with the example. - - ```shell - $ mv README.md CHECKLIST.md - $ mv README.example.md README.md - ``` - -2. Go through the [checklist](#checklist). -3. Remove the temporary checklist. - ```shell - $ rm CHECKLIST.md - ``` - -<a name="checklist"></a> - -## Checklist - -Go through this checklist after creating your repository. It should only take a couple of minutes. - -### README.md - -- [ ] Is the `<title>` field correct? -- [ ] Is the `<description>` field correct? -- [ ] Are the `<repo-name>` fields correct? -- [ ] Is the date (range) of the license correct? - -### Package.json - -- [ ] Is the `name` field correct? -- [ ] Is the `description` field correct? -- [ ] Is the `version` field correct? - Use `npm version 0.1.0 --git-tag-version=false` to set the version, `0.1.0` in this example. -- [ ] Is the `author` field correct? -- [ ] Have you added `keywords`? -- [ ] Are the `repository.url`, `bugs` and `homepage` links correct? - -### Language setup - -### Typescript - -- [ ] Is there a `tsconfig.json` file? - See [vidavidorra/next-standard-version](https://github.com/vidavidorra/next-standard-version) for an example of the file. +| Badge | Description | Service | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------- | -------------------- | +| <a href="https://github.com/prettier/prettier#readme"><img alt="code style" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"></a> | Code style | Prettier | +| <a href="https://conventionalcommits.org"><img alt="Conventional Commits: 1.0.0" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square"></a> | Commit style | Conventional Commits | +| <a href="https://github.com/vidavidorra/github-action-renovate/actions"><img alt="GitHub workflow status" src="https://img.shields.io/github/workflow/status/vidavidorra/github-action-renovate/Lint%20commit%20messages?style=flat-square"></a> | Lint commit messages | GitHub Actions | +| <a href="https://github.com/vidavidorra/github-action-renovate/actions"><img alt="GitHub workflow status" src="https://img.shields.io/github/workflow/status/vidavidorra/github-action-renovate/Lint?style=flat-square"></a> | Lint | GitHub Actions | <a name="license"></a> @@ -77,7 +26,7 @@ Go through this checklist after creating your repository. It should only take a This project is licensed under the [GPLv3 license](https://www.gnu.org/licenses/gpl.html). -Copyright © 2019-2020 Jeroen de Bruijn +Copyright © 2020 Jeroen de Bruijn <details><summary>License details.</summary> <p> diff --git a/package-lock.json b/package-lock.json index 5e26b7bc..fda3d002 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "repo-template", - "version": "1.0.0", + "version": "0.1.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 75dedece..95fee0a9 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "repo-template", - "version": "1.0.0", - "description": "A template for creating new repositories.", + "name": "github-action-renovate", + "version": "0.1.0", + "description": "GitHub Action to run Renovate self-hosted.", "scripts": { "lint": "eslint --ignore-path .prettierignore --ext .ts,.tsx,.js,.jsx,.json .", "lint-file": "eslint --ignore-path .prettierignore", @@ -15,14 +15,14 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/vidavidorra/repo-template.git" + "url": "git+https://github.com/vidavidorra/github-action-renovate.git" }, "author": "Jeroen de Bruijn", "license": "GPL-3.0-or-later", "bugs": { - "url": "https://github.com/vidavidorra/repo-template/issues" + "url": "https://github.com/vidavidorra/github-action-renovate/issues" }, - "homepage": "https://github.com/vidavidorra/repo-template#readme", + "homepage": "https://github.com/vidavidorra/github-action-renovate#readme", "dependencies": {}, "devDependencies": { "@commitlint/cli": "8.3.5",