actions/renovatebot-github
1
0
Fork 0
mirror of https://github.com/renovatebot/github-action.git synced 2025-12-15 16:32:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

chore: initialise repository e.a. readme, package.json

Browse source
This commit is contained in:
Jeroen de Bruijn 2020-03-18 20:55:49 +01:00
parent 9e3a503182
commit 515e31cf90
No known key found for this signature in database
GPG key ID: 7D12D6AB2A547EBB
4 changed files with 16 additions and 116 deletions
Download patch file Download diff file Expand all files Collapse all files

69
README.md
View file

@ -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>